Package org.apache.iotdb.confignode.persistence.schema

Class ClusterSchemaInfo

java.lang.Object

org.apache.iotdb.confignode.persistence.schema.ClusterSchemaInfo

All Implemented Interfaces:

SnapshotProcessor

public class ClusterSchemaInfo
extends Object
implements SnapshotProcessor

The ClusterSchemaInfo stores cluster schemaEngine. The cluster schemaEngine including: 1. StorageGroupSchema 2. Template (Not implement yet)

Constructor Summary

Constructors

Constructor	Description
ClusterSchemaInfo()

Method Summary

Modifier and Type	Method	Description
TSStatus	adjustMaxRegionGroupCount(AdjustMaxRegionGroupNumPlan plan)	Adjust the maximum RegionGroup count of each Database.
TSStatus	alterDatabase(DatabaseSchemaPlan plan)	Alter DatabaseSchema.
void	checkDatabaseLimit()	Check database limit if necessary.
TemplateInfoResp	checkTemplateSettable(CheckTemplateSettablePlan checkTemplateSettablePlan)
void	clear()
TSStatus	commitSetSchemaTemplate(CommitSetSchemaTemplatePlan commitSetSchemaTemplatePlan)
CountDatabaseResp	countMatchedDatabases(CountDatabasePlan plan)
TSStatus	createDatabase(DatabaseSchemaPlan plan)	Cache DatabaseSchema.
TSStatus	createSchemaTemplate(CreateSchemaTemplatePlan createSchemaTemplatePlan)
TSStatus	deleteDatabase(DeleteDatabasePlan plan)	Delete Database.
TSStatus	dropSchemaTemplate(DropSchemaTemplatePlan dropSchemaTemplatePlan)
TSStatus	extendSchemaTemplate(ExtendSchemaTemplatePlan extendSchemaTemplatePlan)
TemplateInfoResp	getAllTemplates()
AllTemplateSetInfoResp	getAllTemplateSetInfo()
org.apache.tsfile.utils.Pair<Set<TSchemaNode>,Set<PartialPath>>	getChildNodePathInNextLevel(PartialPath partialPath, PathPatternTree scope)
List<String>	getDatabaseNames()	Only leader use this interface.
TDatabaseSchema	getMatchedDatabaseSchemaByName(String database)	Only leader use this interface.
DatabaseSchemaResp	getMatchedDatabaseSchemas(GetDatabasePlan plan)
Map<String,TDatabaseSchema>	getMatchedDatabaseSchemasByName(List<String> rawPathList)	Only leader use this interface.
Map<String,TDatabaseSchema>	getMatchedDatabaseSchemasByOneName(String[] databasePathPattern)
Map<String,TDatabaseSchema>	getMatchedDatabaseSchemasByPrefix(PartialPath prefix)	Only leader use this interface.
int	getMaxRegionGroupNum(String database, TConsensusGroupType consensusGroupType)	Only leader use this interface.
int	getMinRegionGroupNum(String database, TConsensusGroupType consensusGroupType)	Only leader use this interface.
org.apache.tsfile.utils.Pair<List<PartialPath>,Set<PartialPath>>	getNodesListInGivenLevel(PartialPath partialPath, int level, PathPatternTree scope)
PathInfoResp	getPathsSetTemplate(GetPathsSetTemplatePlan getPathsSetTemplatePlan)
Template	getTemplate(int id)
TemplateInfoResp	getTemplate(GetSchemaTemplatePlan getSchemaTemplatePlan)
TemplateSetInfoResp	getTemplateSetInfo(GetTemplateSetInfoPlan plan)	Get the templateId set on paths covered by input path pattern.
void	isDatabaseNameValid(String databaseName)	Check if the specified DatabaseName is valid.
TSStatus	preSetSchemaTemplate(PreSetSchemaTemplatePlan preSetSchemaTemplatePlan)
TSStatus	preUnsetSchemaTemplate(PreUnsetSchemaTemplatePlan plan)
void	processLoadSnapshot(File snapshotDir)
void	processMTreeLoadSnapshot(File snapshotDir)
boolean	processMTreeTakeSnapshot(File snapshotDir)
boolean	processTakeSnapshot(File snapshotDir)
TSStatus	rollbackUnsetSchemaTemplate(RollbackPreUnsetSchemaTemplatePlan plan)
TSStatus	setDataReplicationFactor(SetDataReplicationFactorPlan plan)
TSStatus	setSchemaReplicationFactor(SetSchemaReplicationFactorPlan plan)
TSStatus	setSchemaTemplate(SetSchemaTemplatePlan setSchemaTemplatePlan)
TSStatus	setTimePartitionInterval(SetTimePartitionIntervalPlan plan)
TSStatus	unsetSchemaTemplate(UnsetSchemaTemplatePlan plan)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClusterSchemaInfo

public ClusterSchemaInfo()
                  throws IOException

Throws:

IOException

Method Details

createDatabase

public TSStatus createDatabase(DatabaseSchemaPlan plan)

Cache DatabaseSchema.

Parameters:

plan - DatabaseSchemaPlan

Returns:

SUCCESS_STATUS if the Database is set successfully.

alterDatabase

public TSStatus alterDatabase(DatabaseSchemaPlan plan)

Alter DatabaseSchema.

Parameters:

plan - DatabaseSchemaPlan

Returns:

SUCCESS_STATUS if the DatabaseSchema is altered successfully.

deleteDatabase

public TSStatus deleteDatabase(DeleteDatabasePlan plan)

Delete Database.

Parameters:

plan - DeleteDatabasePlan

Returns:

SUCCESS_STATUS

checkDatabaseLimit

public void checkDatabaseLimit()
                        throws MetadataException

Check database limit if necessary.

Throws:

SchemaQuotaExceededException - if the number of databases exceeds the limit

MetadataException - if other exceptions happen

countMatchedDatabases

public CountDatabaseResp countMatchedDatabases(CountDatabasePlan plan)

Returns:

The number of matched Databases by the specified Database pattern

getMatchedDatabaseSchemas

public DatabaseSchemaResp getMatchedDatabaseSchemas(GetDatabasePlan plan)

Returns:

All DatabaseSchemas that matches to the specified Database pattern

setSchemaReplicationFactor

public TSStatus setSchemaReplicationFactor(SetSchemaReplicationFactorPlan plan)

setDataReplicationFactor

public TSStatus setDataReplicationFactor(SetDataReplicationFactorPlan plan)

setTimePartitionInterval

public TSStatus setTimePartitionInterval(SetTimePartitionIntervalPlan plan)

adjustMaxRegionGroupCount

public TSStatus adjustMaxRegionGroupCount(AdjustMaxRegionGroupNumPlan plan)

Adjust the maximum RegionGroup count of each Database.

Parameters:

plan - AdjustMaxRegionGroupCountPlan

Returns:

SUCCESS_STATUS

getDatabaseNames

public List<String> getDatabaseNames()

Only leader use this interface.

Returns:

List <DatabaseName>, all Databases' name.

isDatabaseNameValid

public void isDatabaseNameValid(String databaseName)
                         throws MetadataException

Check if the specified DatabaseName is valid.

Parameters:

databaseName - The specified DatabaseName

Throws:

MetadataException - If the DatabaseName invalid i.e. the specified DatabaseName is already exist, or it's a prefix of another DatabaseName

getMatchedDatabaseSchemaByName

public TDatabaseSchema getMatchedDatabaseSchemaByName(String database)
                                               throws DatabaseNotExistsException

Only leader use this interface. Get the specific TDatabaseSchema

Parameters:

database - DatabaseName

Returns:

The specific DatabaseSchema

Throws:

DatabaseNotExistsException - When the specific Database doesn't exist

getMatchedDatabaseSchemasByName

public Map<String,TDatabaseSchema> getMatchedDatabaseSchemasByName(List<String> rawPathList)

Only leader use this interface. Get the matched DatabaseSchemas.

Parameters:

rawPathList - Databases' path patterns or full paths

Returns:

All DatabaseSchemas that matches to the specific Database patterns

getMatchedDatabaseSchemasByPrefix

public Map<String,TDatabaseSchema> getMatchedDatabaseSchemasByPrefix(PartialPath prefix)

Only leader use this interface. Get the matched DatabaseSchemas.

Parameters:

prefix - prefix path such as root.a

Returns:

All DatabaseSchemas that matches to the prefix path such as root.a.db1, root.a.db2

getMinRegionGroupNum

public int getMinRegionGroupNum(String database,
 TConsensusGroupType consensusGroupType)

Only leader use this interface. Get the maxRegionGroupNum of specified Database.

Parameters:

database - DatabaseName

consensusGroupType - SchemaRegion or DataRegion

Returns:

maxSchemaRegionGroupNum or maxDataRegionGroupNum

getMaxRegionGroupNum

public int getMaxRegionGroupNum(String database,
 TConsensusGroupType consensusGroupType)

Only leader use this interface. Get the maxRegionGroupNum of specified Database.

Parameters:

database - DatabaseName

consensusGroupType - SchemaRegion or DataRegion

Returns:

maxSchemaRegionGroupNum or maxDataRegionGroupNum

processTakeSnapshot

public boolean processTakeSnapshot(File snapshotDir)
                            throws IOException

Specified by:

processTakeSnapshot in interface SnapshotProcessor

Throws:

IOException

processMTreeTakeSnapshot

public boolean processMTreeTakeSnapshot(File snapshotDir)
                                 throws IOException

Throws:

IOException

processLoadSnapshot

public void processLoadSnapshot(File snapshotDir)
                         throws IOException

Specified by:

processLoadSnapshot in interface SnapshotProcessor

Throws:

IOException

processMTreeLoadSnapshot

public void processMTreeLoadSnapshot(File snapshotDir)
                              throws IOException

Throws:

IOException

getNodesListInGivenLevel

public org.apache.tsfile.utils.Pair<List<PartialPath>,Set<PartialPath>> getNodesListInGivenLevel(PartialPath partialPath,
 int level,
 PathPatternTree scope)

getChildNodePathInNextLevel

public org.apache.tsfile.utils.Pair<Set<TSchemaNode>,Set<PartialPath>> getChildNodePathInNextLevel(PartialPath partialPath,
 PathPatternTree scope)

createSchemaTemplate

public TSStatus createSchemaTemplate(CreateSchemaTemplatePlan createSchemaTemplatePlan)

getAllTemplates

public TemplateInfoResp getAllTemplates()

getTemplate

public TemplateInfoResp getTemplate(GetSchemaTemplatePlan getSchemaTemplatePlan)

getTemplate

public Template getTemplate(int id)
                     throws MetadataException

Throws:

MetadataException

checkTemplateSettable

public TemplateInfoResp checkTemplateSettable(CheckTemplateSettablePlan checkTemplateSettablePlan)

setSchemaTemplate

public TSStatus setSchemaTemplate(SetSchemaTemplatePlan setSchemaTemplatePlan)

preSetSchemaTemplate

public TSStatus preSetSchemaTemplate(PreSetSchemaTemplatePlan preSetSchemaTemplatePlan)

commitSetSchemaTemplate

public TSStatus commitSetSchemaTemplate(CommitSetSchemaTemplatePlan commitSetSchemaTemplatePlan)

getPathsSetTemplate

public PathInfoResp getPathsSetTemplate(GetPathsSetTemplatePlan getPathsSetTemplatePlan)

getAllTemplateSetInfo

public AllTemplateSetInfoResp getAllTemplateSetInfo()

getTemplateSetInfo

public TemplateSetInfoResp getTemplateSetInfo(GetTemplateSetInfoPlan plan)

Get the templateId set on paths covered by input path pattern. Resolve the input path patterns into specified path pattern start with template set path. The result set is organized as specified path pattern -> template id

preUnsetSchemaTemplate

public TSStatus preUnsetSchemaTemplate(PreUnsetSchemaTemplatePlan plan)

rollbackUnsetSchemaTemplate

public TSStatus rollbackUnsetSchemaTemplate(RollbackPreUnsetSchemaTemplatePlan plan)

unsetSchemaTemplate

public TSStatus unsetSchemaTemplate(UnsetSchemaTemplatePlan plan)

dropSchemaTemplate

public TSStatus dropSchemaTemplate(DropSchemaTemplatePlan dropSchemaTemplatePlan)

extendSchemaTemplate

public TSStatus extendSchemaTemplate(ExtendSchemaTemplatePlan extendSchemaTemplatePlan)

getMatchedDatabaseSchemasByOneName

public Map<String,TDatabaseSchema> getMatchedDatabaseSchemasByOneName(String[] databasePathPattern)

clear

public void clear()