MManager (IoTDB Server 0.13.2 API)

java.lang.Object
- org.apache.iotdb.db.metadata.MManager

```
public class MManager
extends Object
```
This class takes the responsibility of serialization of all the metadata info and persistent it into files. This class contains all the interfaces to modify the metadata for delta system. All the operations will be insert into the logs temporary in case the downtime of the delta system.
Since there are too many interfaces and methods in this class, we use code region to help manage code. The code region starts with //region and ends with //endregion. When using Intellij Idea to develop, it's easy to fold the code region and see code region overview by collapsing all.
The codes are divided into the following code regions:
1. MManager Singleton
2. Interfaces and Implementation of MManager initialization、snapshot、recover and clear
3. Interfaces for CQ
4. Interfaces and Implementation for Timeseries operation
5. Interfaces and Implementation for StorageGroup and TTL operation
6. Interfaces for get and auto create device
7. Interfaces for metadata info Query
  1. Interfaces for metadata count
  2. Interfaces for level Node info Query
  3. Interfaces for StorageGroup and TTL info Query
  4. Interfaces for Entity/Device info Query
  5. Interfaces for timeseries, measurement and schema info Query
8. Interfaces and methods for MNode query
9. Interfaces for alias and tag/attribute operations
10. Interfaces only for Cluster module usage
11. Interfaces for lastCache operations
12. Interfaces and Implementation for InsertPlan process
13. Interfaces and Implementation for Template operations
14. TestOnly Interfaces

嵌套类概要

嵌套类
限定符和类型	类和说明
`static interface`	`MManager.StorageGroupFilter` StorageGroupFilter filters unsatisfied storage groups in metadata queries to speed up and deduplicate.

字段概要

字段
限定符和类型字段和说明

protected static IoTDBConfig config

static String TIME_SERIES_TREE_HEADER

字段
限定符和类型	字段和说明
`protected static IoTDBConfig`	`config`
`static String`	`TIME_SERIES_TREE_HEADER`

构造器概要

构造器
限定符构造器和说明

protected MManager()

构造器
限定符	构造器和说明
`protected`	`MManager()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addAttributes(Map<String,String> attributesMap, PartialPath fullPath)` add new attributes key-value for the timeseries
`void`	`addTags(Map<String,String> tagsMap, PartialPath fullPath)` add new tags key-value for the timeseries
`void`	`appendSchemaTemplate(AppendTemplatePlan plan)`
`void`	`cacheMeta(PartialPath path, IMeasurementMNode measurementMNode, boolean needSetFullPath)` if the path is in local mtree, nothing needed to do (because mtree is in the memory); Otherwise cache the path to mRemoteSchemaCache
`void`	`changeAlias(PartialPath path, String alias)`
`void`	`changeOffset(PartialPath path, long offset)` Check whether the given path contains a storage group change or set the new offset of a timeseries
`boolean`	`checkStorageGroupByPath(PartialPath path)` Check whether the given path contains a storage group
`void`	`checkTTLOnLastCache()`
`void`	`clear()` function for clearing MTree
`void`	`collectMeasurementSchema(PartialPath prefixPath, List<IMeasurementSchema> measurementSchemas)` Collect the timeseries schemas as IMeasurementSchema under "prefixPath".
`void`	`collectTimeseriesSchema(PartialPath prefixPath, Collection<TimeseriesSchema> timeseriesSchemas)` Collect the timeseries schemas as TimeseriesSchema under "prefixPath".
`int`	`countMeasurementsInTemplate(String templateName)`
`void`	`createAlignedTimeSeries(CreateAlignedTimeSeriesPlan plan)` create aligned timeseries
`void`	`createAlignedTimeSeries(PartialPath prefixPath, List<String> measurements, List<TSDataType> dataTypes, List<TSEncoding> encodings, List<CompressionType> compressors)`
`void`	`createMTreeSnapshot()`
`void`	`createSchemaTemplate(CreateTemplatePlan plan)`
`void`	`createTimeseries(CreateTimeSeriesPlan plan)`
`void`	`createTimeseries(CreateTimeSeriesPlan plan, long offset)`
`void`	`createTimeseries(PartialPath path, TSDataType dataType, TSEncoding encoding, CompressionType compressor, Map<String,String> props)` Add one timeseries to metadata tree, if the timeseries already exists, throw exception
`void`	`deactivateSchemaTemplate(DeactivateTemplatePlan plan)`
`void`	`deleteLastCacheByDevice(PartialPath deviceId)` delete all the last cache value of any timeseries or aligned timeseries under the device Invoking scenario (1) after upload tsfile
`void`	`deleteLastCacheByDevice(PartialPath deviceId, PartialPath originalPath, long startTime, long endTime)` delete the last cache value of timeseries or subMeasurement of some aligned timeseries, which is under the device and matching the originalPath Invoking scenario (1) delete timeseries
`void`	`deleteStorageGroups(List<PartialPath> storageGroups)` Delete storage groups of given paths from MTree.
`String`	`deleteTimeseries(PartialPath pathPattern)` Delete all timeseries matching the given path pattern, may cross different storage group
`String`	`deleteTimeseries(PartialPath pathPattern, boolean isPrefixMatch)` Delete all timeseries matching the given path pattern, may cross different storage group.
`void`	`dropSchemaTemplate(DropTemplatePlan plan)`
`void`	`dropTagsOrAttributes(Set<String> keySet, PartialPath fullPath)` drop tags or attributes of the timeseries
`void`	`flushAllMlogForTest()`
`List<MeasurementPath>`	`getAllMeasurementByDevicePath(PartialPath devicePath)`
`Map<PartialPath,IMeasurementSchema>`	`getAllMeasurementSchemaByPrefix(PartialPath prefixPath)`
`List<IStorageGroupMNode>`	`getAllStorageGroupNodes()` Get all storage group MNodes
`List<PartialPath>`	`getAllStorageGroupPaths()` Get all storage group paths
`Set<String>`	`getAllTemplates()`
`int`	`getAllTimeseriesCount(PartialPath pathPattern)` To calculate the count of timeseries matching given path.
`int`	`getAllTimeseriesCount(PartialPath pathPattern, boolean isPrefixMatch)` To calculate the count of timeseries matching given path.
`Set<PartialPath>`	`getBelongedDevices(PartialPath timeseries)` Get all devices that one of the timeseries, matching the given timeseries path pattern, belongs to.
`PartialPath`	`getBelongedStorageGroup(PartialPath path)` Get storage group name by path e.g., root.sg1 is a storage group and path = root.sg1.d1, return root.sg1
`List<PartialPath>`	`getBelongedStorageGroups(PartialPath pathPattern)` Get the storage group that given path pattern matches or belongs to.
`Set<String>`	`getChildNodeNameInNextLevel(PartialPath pathPattern)` Get child node in the next level of the given path pattern.
`Set<String>`	`getChildNodeNameInNextLevel(PartialPath pathPattern, int limit, int offset)`
`Set<String>`	`getChildNodePathInNextLevel(PartialPath pathPattern)` Get child node path in the next level of the given path pattern.
`Set<String>`	`getChildNodePathInNextLevel(PartialPath pathPattern, int limit, int offset)`
`String`	`getDeviceId(PartialPath devicePath)` To reduce the String number in memory, use the deviceId from MManager instead of the deviceId read from disk
`IMNode`	`getDeviceNode(PartialPath path)`
`protected IMNode`	`getDeviceNodeWithAutoCreate(PartialPath path)`
`protected IMNode`	`getDeviceNodeWithAutoCreate(PartialPath path, boolean autoCreateSchema, boolean allowCreateSg, int sgLevel)` get device node, if the storage group is not set, create it when autoCreateSchema is true (we develop this method as we need to get the node's lock after we get the lock.writeLock())
`int`	`getDevicesNum(PartialPath pathPattern)` To calculate the count of devices for given path pattern.
`int`	`getDevicesNum(PartialPath pathPattern, boolean isPrefixMatch)` To calculate the count of devices for given path pattern.
`static MManager`	`getInstance()` we should not use this function in other place, but only in IoTDB class
`TimeValuePair`	`getLastCache(IMeasurementMNode node)` Get the last cache value in given MeasurementMNode.
`TimeValuePair`	`getLastCache(PartialPath seriesPath)` Get the last cache value of time series of given seriesPath.
`Set<PartialPath>`	`getMatchedDevices(PartialPath pathPattern, boolean isPrefixMatch)` Get all device paths matching the path pattern.
`List<ShowDevicesResult>`	`getMatchedDevices(ShowDevicesPlan plan)` Get all device paths and according storage group paths as ShowDevicesResult.
`List<PartialPath>`	`getMatchedStorageGroups(PartialPath pathPattern, boolean isPrefixMatch)` Get all storage group matching given path pattern.
`Map<PartialPath,Integer>`	`getMeasurementCountGroupByLevel(PartialPath pathPattern, int level, boolean isPrefixMatch)`
`protected IMeasurementMNode`	`getMeasurementMNode(IMNode deviceMNode, String measurementName)` Invoked during insertPlan process.
`IMeasurementMNode`	`getMeasurementMNode(PartialPath fullPath)`
`IMeasurementMNode[]`	`getMeasurementMNodes(PartialPath deviceId, String[] measurements)`
`List<MeasurementPath>`	`getMeasurementPaths(PartialPath pathPattern)` Return all measurement paths for given path if the path is abstract.
`List<MeasurementPath>`	`getMeasurementPaths(PartialPath pathPattern, boolean isPrefixMatch)` Return all measurement paths for given path if the path is abstract.
`Pair<List<MeasurementPath>,Integer>`	`getMeasurementPathsWithAlias(PartialPath pathPattern, int limit, int offset, boolean isPrefixMatch)` Similar to method getMeasurementPaths(), but return Path with alias and filter the result by limit and offset.
`List<String>`	`getMeasurementsInTemplate(String templateName, String path)`
`String`	`getMetadataInString()` Get metadata in string
`int`	`getNodesCountInGivenLevel(PartialPath pathPattern, int level)` To calculate the count of nodes in the given level for given path pattern.
`int`	`getNodesCountInGivenLevel(PartialPath pathPattern, int level, boolean isPrefixMatch)` To calculate the count of nodes in the given level for given path pattern.
`List<PartialPath>`	`getNodesListInGivenLevel(PartialPath pathPattern, int nodeLevel)` Get all nodes matching the given path pattern in the given level.
`List<PartialPath>`	`getNodesListInGivenLevel(PartialPath pathPattern, int nodeLevel, MManager.StorageGroupFilter filter)`
`Set<String>`	`getPathsSetTemplate(String templateName)` Get all paths set designated template
`Set<String>`	`getPathsUsingTemplate(String templateName)` A shortcut mainly for viewing paths using template.
`Set<PartialPath>`	`getPathsUsingTemplateUnderPrefix(String templateName, String prefix, boolean prefixMatch)` Complete filter of paths using template, detail at `MTree.getPathsUsingTemplateUnderPrefix(org.apache.iotdb.db.metadata.template.Template, org.apache.iotdb.db.metadata.path.PartialPath, boolean)`
`List<Pair<String,IMeasurementSchema>>`	`getSchemasInTemplate(String templateName, String path)`
`IMeasurementSchema`	`getSeriesSchema(PartialPath fullPath)` Get schema of paritialPath
`IMNode`	`getSeriesSchemasAndReadLockDevice(InsertPlan plan)` get schema for device.
`TSDataType`	`getSeriesType(PartialPath fullPath)` Get series type for given seriesPath.
`IStorageGroupMNode`	`getStorageGroupNodeByPath(PartialPath path)` Get storage group node by path. the give path don't need to be storage group path.
`IStorageGroupMNode`	`getStorageGroupNodeByStorageGroupPath(PartialPath path)` E.g., root.sg is storage group given [root, sg], return the MNode of root.sg given [root, sg, device], return the MNode of root.sg Get storage group node by path.
`int`	`getStorageGroupNum(PartialPath pathPattern, boolean isPrefixMatch)` To calculate the count of storage group for given path pattern.
`Map<PartialPath,Long>`	`getStorageGroupsTTL()` get all storageGroups ttl
`Template`	`getTemplate(String templateName)`
`long`	`getTotalNormalSeriesNumber()`
`long`	`getTotalTemplateSeriesNumber()`
`Map<String,List<PartialPath>>`	`groupPathByStorageGroup(PartialPath path)` For a path, infer all storage groups it may belong to.
`void`	`init()`
`void`	`initForMultiMManagerTest()` Attention!!!!!
`boolean`	`isMeasurementInTemplate(String templateName, String path)`
`boolean`	`isPathExist(PartialPath path)` Check whether the path exists.
`boolean`	`isPathExistsInTemplate(String templateName, String path)`
`boolean`	`isStorageGroup(PartialPath path)` Check if the given path is storage group or not.
`void`	`operation(PhysicalPlan plan)`
`void`	`pruneSchemaTemplate(PruneTemplatePlan plan)`
`void`	`renameTagOrAttributeKey(String oldKey, String newKey, PartialPath fullPath)` rename the tag or attribute's key of the timeseries
`void`	`resetLastCache(PartialPath seriesPath)` Reset the last cache value of time series of given seriesPath.
`void`	`setSchemaTemplate(SetTemplatePlan plan)`
`void`	`setSeriesNumerMonitor(ISeriesNumerMonitor seriesNumerMonitor)`
`void`	`setStorageGroup(PartialPath storageGroup)` Set storage group of the given path to MTree.
`void`	`setTagsOrAttributesValue(Map<String,String> alterMap, PartialPath fullPath)` set/change the values of tags or attributes
`void`	`setTTL(PartialPath storageGroup, long dataTTL)`
`void`	`setUsingSchemaTemplate(ActivateTemplatePlan plan)`
`List<ShowTimeSeriesResult>`	`showTimeseries(ShowTimeSeriesPlan plan, QueryContext context)`
`void`	`unsetSchemaTemplate(UnsetTemplatePlan plan)`
`void`	`updateLastCache(IMeasurementMNode node, TimeValuePair timeValuePair, boolean highPriorityUpdate, Long latestFlushedTime)` Update the last cache value in given MeasurementMNode. work.
`void`	`updateLastCache(PartialPath seriesPath, TimeValuePair timeValuePair, boolean highPriorityUpdate, Long latestFlushedTime)` Update the last cache value of time series of given seriesPath.
`void`	`upsertTagsAndAttributes(String alias, Map<String,String> tagsMap, Map<String,String> attributesMap, PartialPath fullPath)` upsert tags and attributes key-value for the timeseries if the key has existed, just use the new value to update it.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - TIME_SERIES_TREE_HEADER
```
public static final String TIME_SERIES_TREE_HEADER
```
    另请参阅:
    
    常量字段值
  - config
```
protected static IoTDBConfig config
```
- 构造器详细资料
  - MManager
```
protected MManager()
```
- 方法详细资料
  - setSeriesNumerMonitor
```
public void setSeriesNumerMonitor(ISeriesNumerMonitor seriesNumerMonitor)
```
  - getInstance
```
public static MManager getInstance()
```
    we should not use this function in other place, but only in IoTDB class
  - init
```
public void init()
```
  - createMTreeSnapshot
```
public void createMTreeSnapshot()
```
  - clear
```
public void clear()
```
    function for clearing MTree
  - operation
```
public void operation(PhysicalPlan plan)
               throws IOException,
                      MetadataException
```
    抛出:
    
    IOException
    
    MetadataException
  - createTimeseries
```
public void createTimeseries(CreateTimeSeriesPlan plan)
                      throws MetadataException
```
    抛出:
    
    MetadataException
  - createTimeseries
```
public void createTimeseries(CreateTimeSeriesPlan plan,
                             long offset)
                      throws MetadataException
```
    抛出:
    
    MetadataException
  - createTimeseries
```
public void createTimeseries(PartialPath path,
                             TSDataType dataType,
                             TSEncoding encoding,
                             CompressionType compressor,
                             Map<String,String> props)
                      throws MetadataException
```
    Add one timeseries to metadata tree, if the timeseries already exists, throw exception
    
    参数:
    
    path - the timeseries path
    
    dataType - the dateType DataType of the timeseries
    
    encoding - the encoding function Encoding of the timeseries
    
    compressor - the compressor function Compressor of the time series
    
    抛出:
    
    MetadataException
  - createAlignedTimeSeries
```
public void createAlignedTimeSeries(PartialPath prefixPath,
                                    List<String> measurements,
                                    List<TSDataType> dataTypes,
                                    List<TSEncoding> encodings,
                                    List<CompressionType> compressors)
                             throws MetadataException
```
    抛出:
    
    MetadataException
  - createAlignedTimeSeries
```
public void createAlignedTimeSeries(CreateAlignedTimeSeriesPlan plan)
                             throws MetadataException
```
    create aligned timeseries
    
    参数:
    
    plan - CreateAlignedTimeSeriesPlan
    
    抛出:
    
    MetadataException
  - deleteTimeseries
```
public String deleteTimeseries(PartialPath pathPattern,
                               boolean isPrefixMatch)
                        throws MetadataException
```
    Delete all timeseries matching the given path pattern, may cross different storage group. If using prefix match, the path pattern is used to match prefix path. All timeseries start with the matched prefix path will be deleted.
    
    参数:
    
    pathPattern - path to be deleted
    
    isPrefixMatch - if true, the path pattern is used to match prefix path
    
    返回:
    
    deletion failed Timeseries
    
    抛出:
    
    MetadataException
  - deleteTimeseries
```
public String deleteTimeseries(PartialPath pathPattern)
                        throws MetadataException
```
    Delete all timeseries matching the given path pattern, may cross different storage group
    
    参数:
    
    pathPattern - path to be deleted
    
    返回:
    
    deletion failed Timeseries
    
    抛出:
    
    MetadataException
  - setStorageGroup
```
public void setStorageGroup(PartialPath storageGroup)
                     throws MetadataException
```
    Set storage group of the given path to MTree.
    
    参数:
    
    storageGroup - root.node.(node)*
    
    抛出:
    
    MetadataException
  - deleteStorageGroups
```
public void deleteStorageGroups(List<PartialPath> storageGroups)
                         throws MetadataException
```
    Delete storage groups of given paths from MTree. Log format: "delete_storage_group,sg1,sg2,sg3"
    
    参数:
    
    storageGroups - list of paths to be deleted. Format: root.node
    
    抛出:
    
    MetadataException
  - setTTL
```
public void setTTL(PartialPath storageGroup,
                   long dataTTL)
            throws MetadataException,
                   IOException
```
    抛出:
    
    MetadataException
    
    IOException
  - getDeviceNodeWithAutoCreate
```
protected IMNode getDeviceNodeWithAutoCreate(PartialPath path,
                                             boolean autoCreateSchema,
                                             boolean allowCreateSg,
                                             int sgLevel)
                                      throws IOException,
                                             MetadataException
```
    get device node, if the storage group is not set, create it when autoCreateSchema is true
    (we develop this method as we need to get the node's lock after we get the lock.writeLock())
    
    参数:
    
    path - path
    
    allowCreateSg - The stand-alone version can create an sg at will, but the cluster version needs to make the Meta group aware of the creation of an SG, so an exception needs to be thrown here
    
    抛出:
    
    IOException
    
    MetadataException
  - getDeviceNodeWithAutoCreate
```
protected IMNode getDeviceNodeWithAutoCreate(PartialPath path)
                                      throws MetadataException,
                                             IOException
```
    抛出:
    
    MetadataException
    
    IOException
  - isPathExist
```
public boolean isPathExist(PartialPath path)
```
    Check whether the path exists.
    
    参数:
    
    path - a full path or a prefix path
  - getMetadataInString
```
public String getMetadataInString()
```
    Get metadata in string
  - getTotalNormalSeriesNumber
```
public long getTotalNormalSeriesNumber()
```
  - getTotalTemplateSeriesNumber
```
public long getTotalTemplateSeriesNumber()
```
  - getAllTimeseriesCount
```
public int getAllTimeseriesCount(PartialPath pathPattern,
                                 boolean isPrefixMatch)
                          throws MetadataException
```
    To calculate the count of timeseries matching given path. The path could be a pattern of a full path, may contain wildcard. If using prefix match, the path pattern is used to match prefix path. All timeseries start with the matched prefix path will be counted.
    
    抛出:
    
    MetadataException
  - getAllTimeseriesCount
```
public int getAllTimeseriesCount(PartialPath pathPattern)
                          throws MetadataException
```
    To calculate the count of timeseries matching given path. The path could be a pattern of a full path, may contain wildcard.
    
    抛出:
    
    MetadataException
  - getDevicesNum
```
public int getDevicesNum(PartialPath pathPattern,
                         boolean isPrefixMatch)
                  throws MetadataException
```
    To calculate the count of devices for given path pattern. If using prefix match, the path pattern is used to match prefix path. All timeseries start with the matched prefix path will be counted.
    
    抛出:
    
    MetadataException
  - getDevicesNum
```
public int getDevicesNum(PartialPath pathPattern)
                  throws MetadataException
```
    To calculate the count of devices for given path pattern.
    
    抛出:
    
    MetadataException
  - getStorageGroupNum
```
public int getStorageGroupNum(PartialPath pathPattern,
                              boolean isPrefixMatch)
                       throws MetadataException
```
    To calculate the count of storage group for given path pattern. If using prefix match, the path pattern is used to match prefix path. All timeseries start with the matched prefix path will be counted.
    
    抛出:
    
    MetadataException
  - getNodesCountInGivenLevel
```
public int getNodesCountInGivenLevel(PartialPath pathPattern,
                                     int level,
                                     boolean isPrefixMatch)
                              throws MetadataException
```
    To calculate the count of nodes in the given level for given path pattern. If using prefix match, the path pattern is used to match prefix path. All timeseries start with the matched prefix path will be counted.
    
    参数:
    
    pathPattern - a path pattern or a full path
    
    level - the level should match the level of the path
    
    isPrefixMatch - if true, the path pattern is used to match prefix path
    
    抛出:
    
    MetadataException
  - getNodesCountInGivenLevel
```
public int getNodesCountInGivenLevel(PartialPath pathPattern,
                                     int level)
                              throws MetadataException
```
    To calculate the count of nodes in the given level for given path pattern.
    
    参数:
    
    pathPattern - a path pattern or a full path
    
    level - the level should match the level of the path
    
    抛出:
    
    MetadataException
  - getMeasurementCountGroupByLevel
```
public Map<PartialPath,Integer> getMeasurementCountGroupByLevel(PartialPath pathPattern,
                                                                int level,
                                                                boolean isPrefixMatch)
                                                         throws MetadataException
```
    抛出:
    
    MetadataException
  - getNodesListInGivenLevel
```
public List<PartialPath> getNodesListInGivenLevel(PartialPath pathPattern,
                                                  int nodeLevel)
                                           throws MetadataException
```
    Get all nodes matching the given path pattern in the given level. The level of the path should match the nodeLevel. 1. The given level equals the path level with out **, e.g. give path root.*.d.* and the level should be 4. 2. The given level is greater than path level with **, e.g. give path root.** and the level could be 2 or 3.
    
    参数:
    
    pathPattern - can be a pattern of a full path.
    
    nodeLevel - the level should match the level of the path
    
    返回:
    
    A List instance which stores all node at given level
    
    抛出:
    
    MetadataException
  - getNodesListInGivenLevel
```
public List<PartialPath> getNodesListInGivenLevel(PartialPath pathPattern,
                                                  int nodeLevel,
                                                  MManager.StorageGroupFilter filter)
                                           throws MetadataException
```
    抛出:
    
    MetadataException
  - getChildNodePathInNextLevel
```
public Set<String> getChildNodePathInNextLevel(PartialPath pathPattern)
                                        throws MetadataException
```
    Get child node path in the next level of the given path pattern.
    give pathPattern and the child nodes is those matching pathPattern.*
    e.g., MTree has [root.sg1.d1.s1, root.sg1.d1.s2, root.sg1.d2.s1] given path = root.sg1, return [root.sg1.d1, root.sg1.d2]
    
    参数:
    
    pathPattern - The given path
    
    返回:
    
    All child nodes' seriesPath(s) of given seriesPath.
    
    抛出:
    
    MetadataException
  - getChildNodePathInNextLevel
```
public Set<String> getChildNodePathInNextLevel(PartialPath pathPattern,
                                               int limit,
                                               int offset)
                                        throws MetadataException
```
    抛出:
    
    MetadataException
  - getChildNodeNameInNextLevel
```
public Set<String> getChildNodeNameInNextLevel(PartialPath pathPattern)
                                        throws MetadataException
```
    Get child node in the next level of the given path pattern.
    give pathPattern and the child nodes is those matching pathPattern.*
    e.g., MTree has [root.sg1.d1.s1, root.sg1.d1.s2, root.sg1.d2.s1] given path = root.sg1, return [d1, d2] given path = root.sg.d1 return [s1,s2]
    
    返回:
    
    All child nodes of given seriesPath.
    
    抛出:
    
    MetadataException
  - getChildNodeNameInNextLevel
```
public Set<String> getChildNodeNameInNextLevel(PartialPath pathPattern,
                                               int limit,
                                               int offset)
                                        throws MetadataException
```
    抛出:
    
    MetadataException
  - isStorageGroup
```
public boolean isStorageGroup(PartialPath path)
```
    Check if the given path is storage group or not.
    
    参数:
    
    path - Format: root.node.(node)*
  - checkStorageGroupByPath
```
public boolean checkStorageGroupByPath(PartialPath path)
```
    Check whether the given path contains a storage group
  - getBelongedStorageGroup
```
public PartialPath getBelongedStorageGroup(PartialPath path)
                                    throws StorageGroupNotSetException
```
    Get storage group name by path
    e.g., root.sg1 is a storage group and path = root.sg1.d1, return root.sg1
    
    参数:
    
    path - only full path, cannot be path pattern
    
    返回:
    
    storage group in the given path
    
    抛出:
    
    StorageGroupNotSetException
  - getBelongedStorageGroups
```
public List<PartialPath> getBelongedStorageGroups(PartialPath pathPattern)
                                           throws MetadataException
```
    Get the storage group that given path pattern matches or belongs to.
    Suppose we have (root.sg1.d1.s1, root.sg2.d2.s2), refer the following cases: 1. given path "root.sg1", ("root.sg1") will be returned. 2. given path "root.*", ("root.sg1", "root.sg2") will be returned. 3. given path "root.*.d1.s1", ("root.sg1", "root.sg2") will be returned.
    
    参数:
    
    pathPattern - a path pattern or a full path
    
    返回:
    
    a list contains all storage groups related to given path pattern
    
    抛出:
    
    MetadataException
  - getMatchedStorageGroups
```
public List<PartialPath> getMatchedStorageGroups(PartialPath pathPattern,
                                                 boolean isPrefixMatch)
                                          throws MetadataException
```
    Get all storage group matching given path pattern. If using prefix match, the path pattern is used to match prefix path. All timeseries start with the matched prefix path will be collected.
    
    参数:
    
    pathPattern - a pattern of a full path
    
    isPrefixMatch - if true, the path pattern is used to match prefix path
    
    返回:
    
    A ArrayList instance which stores storage group paths matching given path pattern.
    
    抛出:
    
    MetadataException
  - getAllStorageGroupPaths
```
public List<PartialPath> getAllStorageGroupPaths()
```
    Get all storage group paths
  - getStorageGroupsTTL
```
public Map<PartialPath,Long> getStorageGroupsTTL()
```
    get all storageGroups ttl
    
    返回:
    
    key-> storageGroupPath, value->ttl
  - getBelongedDevices
```
public Set<PartialPath> getBelongedDevices(PartialPath timeseries)
                                    throws MetadataException
```
    Get all devices that one of the timeseries, matching the given timeseries path pattern, belongs to.
    
    参数:
    
    timeseries - a path pattern of the target timeseries
    
    返回:
    
    A HashSet instance which stores devices paths.
    
    抛出:
    
    MetadataException
  - getMatchedDevices
```
public Set<PartialPath> getMatchedDevices(PartialPath pathPattern,
                                          boolean isPrefixMatch)
                                   throws MetadataException
```
    Get all device paths matching the path pattern. If using prefix match, the path pattern is used to match prefix path. All timeseries start with the matched prefix path will be collected.
    
    参数:
    
    pathPattern - the pattern of the target devices.
    
    isPrefixMatch - if true, the path pattern is used to match prefix path.
    
    返回:
    
    A HashSet instance which stores devices paths matching the given path pattern.
    
    抛出:
    
    MetadataException
  - getMatchedDevices
```
public List<ShowDevicesResult> getMatchedDevices(ShowDevicesPlan plan)
                                          throws MetadataException
```
    Get all device paths and according storage group paths as ShowDevicesResult.
    
    参数:
    
    plan - ShowDevicesPlan which contains the path pattern and restriction params.
    
    返回:
    
    ShowDevicesResult.
    
    抛出:
    
    MetadataException
  - getMeasurementPaths
```
public List<MeasurementPath> getMeasurementPaths(PartialPath pathPattern,
                                                 boolean isPrefixMatch)
                                          throws MetadataException
```
    Return all measurement paths for given path if the path is abstract. Or return the path itself. Regular expression in this method is formed by the amalgamation of seriesPath and the character '*'. If using prefix match, the path pattern is used to match prefix path. All timeseries start with the matched prefix path will be collected.
    
    参数:
    
    pathPattern - can be a pattern or a full path of timeseries.
    
    isPrefixMatch - if true, the path pattern is used to match prefix path
    
    抛出:
    
    MetadataException
  - getMeasurementPaths
```
public List<MeasurementPath> getMeasurementPaths(PartialPath pathPattern)
                                          throws MetadataException
```
    Return all measurement paths for given path if the path is abstract. Or return the path itself. Regular expression in this method is formed by the amalgamation of seriesPath and the character '*'.
    
    参数:
    
    pathPattern - can be a pattern or a full path of timeseries.
    
    抛出:
    
    MetadataException
  - getMeasurementPathsWithAlias
```
public Pair<List<MeasurementPath>,Integer> getMeasurementPathsWithAlias(PartialPath pathPattern,
                                                                        int limit,
                                                                        int offset,
                                                                        boolean isPrefixMatch)
                                                                 throws MetadataException
```
    Similar to method getMeasurementPaths(), but return Path with alias and filter the result by limit and offset. If using prefix match, the path pattern is used to match prefix path. All timeseries start with the matched prefix path will be collected.
    
    参数:
    
    isPrefixMatch - if true, the path pattern is used to match prefix path
    
    抛出:
    
    MetadataException
  - showTimeseries
```
public List<ShowTimeSeriesResult> showTimeseries(ShowTimeSeriesPlan plan,
                                                 QueryContext context)
                                          throws MetadataException
```
    抛出:
    
    MetadataException
  - getSeriesType
```
public TSDataType getSeriesType(PartialPath fullPath)
                         throws MetadataException
```
    Get series type for given seriesPath.
    
    参数:
    
    fullPath - full path
    
    抛出:
    
    MetadataException
  - getSeriesSchema
```
public IMeasurementSchema getSeriesSchema(PartialPath fullPath)
                                   throws MetadataException
```
    Get schema of paritialPath
    
    参数:
    
    fullPath - (may be ParitialPath or AlignedPath)
    
    返回:
    
    MeasurementSchema
    
    抛出:
    
    MetadataException
  - getAllMeasurementByDevicePath
```
public List<MeasurementPath> getAllMeasurementByDevicePath(PartialPath devicePath)
                                                    throws PathNotExistException
```
    抛出:
    
    PathNotExistException
  - getAllMeasurementSchemaByPrefix
```
public Map<PartialPath,IMeasurementSchema> getAllMeasurementSchemaByPrefix(PartialPath prefixPath)
                                                                    throws MetadataException
```
    抛出:
    
    MetadataException
  - getStorageGroupNodeByStorageGroupPath
```
public IStorageGroupMNode getStorageGroupNodeByStorageGroupPath(PartialPath path)
                                                         throws MetadataException
```
    E.g., root.sg is storage group given [root, sg], return the MNode of root.sg given [root, sg, device], return the MNode of root.sg Get storage group node by path. If storage group is not set, StorageGroupNotSetException will be thrown
    
    抛出:
    
    MetadataException
  - getStorageGroupNodeByPath
```
public IStorageGroupMNode getStorageGroupNodeByPath(PartialPath path)
                                             throws MetadataException
```
    Get storage group node by path. the give path don't need to be storage group path.
    
    抛出:
    
    MetadataException
  - getAllStorageGroupNodes
```
public List<IStorageGroupMNode> getAllStorageGroupNodes()
```
    Get all storage group MNodes
  - getDeviceNode
```
public IMNode getDeviceNode(PartialPath path)
                     throws MetadataException
```
    抛出:
    
    MetadataException
  - getMeasurementMNodes
```
public IMeasurementMNode[] getMeasurementMNodes(PartialPath deviceId,
                                                String[] measurements)
                                         throws MetadataException
```
    抛出:
    
    MetadataException
  - getMeasurementMNode
```
public IMeasurementMNode getMeasurementMNode(PartialPath fullPath)
                                      throws MetadataException
```
    抛出:
    
    MetadataException
  - getMeasurementMNode
```
protected IMeasurementMNode getMeasurementMNode(IMNode deviceMNode,
                                                String measurementName)
                                         throws PathAlreadyExistException
```
    Invoked during insertPlan process. Get target MeasurementMNode from given EntityMNode. If the result is not null and is not MeasurementMNode, it means a timeseries with same path cannot be created thus throw PathAlreadyExistException.
    
    抛出:
    
    PathAlreadyExistException
  - changeOffset
```
public void changeOffset(PartialPath path,
                         long offset)
                  throws MetadataException,
                         IOException
```
    Check whether the given path contains a storage group change or set the new offset of a timeseries
    
    参数:
    
    path - timeseries
    
    offset - offset in the tag file
    
    抛出:
    
    MetadataException
    
    IOException
  - changeAlias
```
public void changeAlias(PartialPath path,
                        String alias)
                 throws MetadataException
```
    抛出:
    
    MetadataException
  - upsertTagsAndAttributes
```
public void upsertTagsAndAttributes(String alias,
                                    Map<String,String> tagsMap,
                                    Map<String,String> attributesMap,
                                    PartialPath fullPath)
                             throws MetadataException,
                                    IOException
```
    upsert tags and attributes key-value for the timeseries if the key has existed, just use the new value to update it.
    
    参数:
    
    alias - newly added alias
    
    tagsMap - newly added tags map
    
    attributesMap - newly added attributes map
    
    fullPath - timeseries
    
    抛出:
    
    MetadataException
    
    IOException
  - addAttributes
```
public void addAttributes(Map<String,String> attributesMap,
                          PartialPath fullPath)
                   throws MetadataException,
                          IOException
```
    add new attributes key-value for the timeseries
    
    参数:
    
    attributesMap - newly added attributes map
    
    fullPath - timeseries
    
    抛出:
    
    MetadataException
    
    IOException
  - addTags
```
public void addTags(Map<String,String> tagsMap,
                    PartialPath fullPath)
             throws MetadataException,
                    IOException
```
    add new tags key-value for the timeseries
    
    参数:
    
    tagsMap - newly added tags map
    
    fullPath - timeseries
    
    抛出:
    
    MetadataException
    
    IOException
  - dropTagsOrAttributes
```
public void dropTagsOrAttributes(Set<String> keySet,
                                 PartialPath fullPath)
                          throws MetadataException,
                                 IOException
```
    drop tags or attributes of the timeseries
    
    参数:
    
    keySet - tags key or attributes key
    
    fullPath - timeseries path
    
    抛出:
    
    MetadataException
    
    IOException
  - setTagsOrAttributesValue
```
public void setTagsOrAttributesValue(Map<String,String> alterMap,
                                     PartialPath fullPath)
                              throws MetadataException,
                                     IOException
```
    set/change the values of tags or attributes
    
    参数:
    
    alterMap - the new tags or attributes key-value
    
    fullPath - timeseries
    
    抛出:
    
    MetadataException
    
    IOException
  - renameTagOrAttributeKey
```
public void renameTagOrAttributeKey(String oldKey,
                                    String newKey,
                                    PartialPath fullPath)
                             throws MetadataException,
                                    IOException
```
    rename the tag or attribute's key of the timeseries
    
    参数:
    
    oldKey - old key of tag or attribute
    
    newKey - new key of tag or attribute
    
    fullPath - timeseries
    
    抛出:
    
    MetadataException
    
    IOException
  - collectMeasurementSchema
```
public void collectMeasurementSchema(PartialPath prefixPath,
                                     List<IMeasurementSchema> measurementSchemas)
```
    Collect the timeseries schemas as IMeasurementSchema under "prefixPath".
  - collectTimeseriesSchema
```
public void collectTimeseriesSchema(PartialPath prefixPath,
                                    Collection<TimeseriesSchema> timeseriesSchemas)
```
    Collect the timeseries schemas as TimeseriesSchema under "prefixPath".
  - groupPathByStorageGroup
```
public Map<String,List<PartialPath>> groupPathByStorageGroup(PartialPath path)
                                                      throws MetadataException
```
    For a path, infer all storage groups it may belong to. The path can have wildcards. Resolve the path or path pattern into StorageGroupName-FullPath pairs that FullPath matches the given path.
    Consider the path into two parts: (1) the sub path which can not contain a storage group name and (2) the sub path which is substring that begin after the storage group name.
    (1) Suppose the part of the path can not contain a storage group name (e.g., "root".contains("root.sg") == false), then: For each one level wildcard *, only one level will be inferred and the wildcard will be removed. For each multi level wildcard **, then the inference will go on until the storage groups are found and the wildcard will be kept. (2) Suppose the part of the path is a substring that begin after the storage group name. (e.g., For "root.*.sg1.a.*.b.*" and "root.x.sg1" is a storage group, then this part is "a.*.b.*"). For this part, keep what it is.
    Assuming we have three SGs: root.group1, root.group2, root.area1.group3 Eg1: for input "root.**", returns ("root.group1", "root.group1.**"), ("root.group2", "root.group2.**") ("root.area1.group3", "root.area1.group3.**") Eg2: for input "root.*.s1", returns ("root.group1", "root.group1.s1"), ("root.group2", "root.group2.s1")
    Eg3: for input "root.area1.**", returns ("root.area1.group3", "root.area1.group3.**")
    
    参数:
    
    path - can be a path pattern or a full path.
    
    返回:
    
    StorageGroupName-FullPath pairs
    
    抛出:
    
    MetadataException
  - cacheMeta
```
public void cacheMeta(PartialPath path,
                      IMeasurementMNode measurementMNode,
                      boolean needSetFullPath)
```
    if the path is in local mtree, nothing needed to do (because mtree is in the memory); Otherwise cache the path to mRemoteSchemaCache
  - updateLastCache
```
public void updateLastCache(PartialPath seriesPath,
                            TimeValuePair timeValuePair,
                            boolean highPriorityUpdate,
                            Long latestFlushedTime)
```
    Update the last cache value of time series of given seriesPath.
    MManager will use the seriesPath to search the node first and then process the lastCache in the MeasurementMNode
    Invoking scenario: (1) after executing insertPlan (2) after reading last value from file during last Query
    
    参数:
    
    seriesPath - the PartialPath of full path from root to Measurement
    
    timeValuePair - the latest point value
    
    highPriorityUpdate - the last value from insertPlan is high priority
    
    latestFlushedTime - latest flushed time
  - updateLastCache
```
public void updateLastCache(IMeasurementMNode node,
                            TimeValuePair timeValuePair,
                            boolean highPriorityUpdate,
                            Long latestFlushedTime)
```
    Update the last cache value in given MeasurementMNode. work.
    Invoking scenario: (1) after executing insertPlan (2) after reading last value from file during last Query
    
    参数:
    
    node - the measurementMNode holding the lastCache
    
    timeValuePair - the latest point value
    
    highPriorityUpdate - the last value from insertPlan is high priority
    
    latestFlushedTime - latest flushed time
  - getLastCache
```
public TimeValuePair getLastCache(PartialPath seriesPath)
```
    Get the last cache value of time series of given seriesPath. MManager will use the seriesPath to search the node.
    Invoking scenario: last cache read during last Query
    
    参数:
    
    seriesPath - the PartialPath of full path from root to Measurement
    
    返回:
    
    the last cache value
  - getLastCache
```
public TimeValuePair getLastCache(IMeasurementMNode node)
```
    Get the last cache value in given MeasurementMNode.
    Invoking scenario: last cache read during last Query
    
    参数:
    
    node - the measurementMNode holding the lastCache
    
    返回:
    
    the last cache value
  - resetLastCache
```
public void resetLastCache(PartialPath seriesPath)
```
    Reset the last cache value of time series of given seriesPath. MManager will use the seriesPath to search the node.
    
    参数:
    
    seriesPath - the PartialPath of full path from root to Measurement
  - deleteLastCacheByDevice
```
public void deleteLastCacheByDevice(PartialPath deviceId)
                             throws MetadataException
```
    delete all the last cache value of any timeseries or aligned timeseries under the device
    Invoking scenario (1) after upload tsfile
    
    参数:
    
    deviceId - path of device
    
    抛出:
    
    MetadataException
  - deleteLastCacheByDevice
```
public void deleteLastCacheByDevice(PartialPath deviceId,
                                    PartialPath originalPath,
                                    long startTime,
                                    long endTime)
                             throws MetadataException
```
    delete the last cache value of timeseries or subMeasurement of some aligned timeseries, which is under the device and matching the originalPath
    Invoking scenario (1) delete timeseries
    
    参数:
    
    deviceId - path of device
    
    originalPath - origin timeseries path
    
    startTime - startTime
    
    endTime - endTime
    
    抛出:
    
    MetadataException
  - checkTTLOnLastCache
```
public void checkTTLOnLastCache()
```
  - getSeriesSchemasAndReadLockDevice
```
public IMNode getSeriesSchemasAndReadLockDevice(InsertPlan plan)
                                         throws MetadataException,
                                                IOException
```
    get schema for device. Attention!!! Only support insertPlan
    
    抛出:
    
    MetadataException
    
    IOException
  - createSchemaTemplate
```
public void createSchemaTemplate(CreateTemplatePlan plan)
                          throws MetadataException
```
    抛出:
    
    MetadataException
  - appendSchemaTemplate
```
public void appendSchemaTemplate(AppendTemplatePlan plan)
                          throws MetadataException
```
    抛出:
    
    MetadataException
  - pruneSchemaTemplate
```
public void pruneSchemaTemplate(PruneTemplatePlan plan)
                         throws MetadataException
```
    抛出:
    
    MetadataException
  - countMeasurementsInTemplate
```
public int countMeasurementsInTemplate(String templateName)
                                throws MetadataException
```
    抛出:
    
    MetadataException
  - isMeasurementInTemplate
```
public boolean isMeasurementInTemplate(String templateName,
                                       String path)
                                throws MetadataException
```
    参数:
    
    templateName - name of template to check
    
    path - full path to check
    
    返回:
    
    if path correspond to a measurement in template
    
    抛出:
    
    MetadataException
  - isPathExistsInTemplate
```
public boolean isPathExistsInTemplate(String templateName,
                                      String path)
                               throws MetadataException
```
    抛出:
    
    MetadataException
  - getMeasurementsInTemplate
```
public List<String> getMeasurementsInTemplate(String templateName,
                                              String path)
                                       throws MetadataException
```
    抛出:
    
    MetadataException
  - getSchemasInTemplate
```
public List<Pair<String,IMeasurementSchema>> getSchemasInTemplate(String templateName,
                                                                  String path)
                                                           throws MetadataException
```
    抛出:
    
    MetadataException
  - getAllTemplates
```
public Set<String> getAllTemplates()
```
  - getPathsSetTemplate
```
public Set<String> getPathsSetTemplate(String templateName)
                                throws MetadataException
```
    Get all paths set designated template
    
    参数:
    
    templateName - designated template name, blank string for any template exists
    
    返回:
    
    paths set
    
    抛出:
    
    MetadataException
  - getPathsUsingTemplate
```
public Set<String> getPathsUsingTemplate(String templateName)
                                  throws MetadataException
```
    A shortcut mainly for viewing paths using template.
    
    抛出:
    
    MetadataException
  - getPathsUsingTemplateUnderPrefix
```
public Set<PartialPath> getPathsUsingTemplateUnderPrefix(String templateName,
                                                         String prefix,
                                                         boolean prefixMatch)
                                                  throws MetadataException
```
    Complete filter of paths using template, detail at MTree.getPathsUsingTemplateUnderPrefix(org.apache.iotdb.db.metadata.template.Template, org.apache.iotdb.db.metadata.path.PartialPath, boolean)
    
    抛出:
    
    MetadataException
  - dropSchemaTemplate
```
public void dropSchemaTemplate(DropTemplatePlan plan)
                        throws MetadataException
```
    抛出:
    
    MetadataException
  - setSchemaTemplate
```
public void setSchemaTemplate(SetTemplatePlan plan)
                       throws MetadataException
```
    抛出:
    
    MetadataException
  - unsetSchemaTemplate
```
public void unsetSchemaTemplate(UnsetTemplatePlan plan)
                         throws MetadataException
```
    抛出:
    
    MetadataException
  - setUsingSchemaTemplate
```
public void setUsingSchemaTemplate(ActivateTemplatePlan plan)
                            throws MetadataException
```
    抛出:
    
    MetadataException
  - deactivateSchemaTemplate
```
public void deactivateSchemaTemplate(DeactivateTemplatePlan plan)
                              throws MetadataException
```
    抛出:
    
    MetadataException
  - getDeviceId
```
public String getDeviceId(PartialPath devicePath)
```
    To reduce the String number in memory, use the deviceId from MManager instead of the deviceId read from disk
    
    参数:
    
    devicePath - read from disk
    
    返回:
    
    deviceId
  - initForMultiMManagerTest
```
public void initForMultiMManagerTest()
```
    Attention!!!!!, this method could only be used for Tests involving multiple mmanagers. The singleton of templateManager and tagManager will cause interference between mmanagers if one of the mmanagers invoke init method or clear method
  - flushAllMlogForTest
```
public void flushAllMlogForTest()
                         throws IOException
```
    抛出:
    
    IOException
  - getTemplate
```
public Template getTemplate(String templateName)
                     throws MetadataException
```
    抛出:
    
    MetadataException

类 MManager

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

TIME_SERIES_TREE_HEADER

config

构造器详细资料

MManager

方法详细资料

setSeriesNumerMonitor

getInstance

init

createMTreeSnapshot

clear

operation

createTimeseries

createTimeseries

createTimeseries

createAlignedTimeSeries

createAlignedTimeSeries

deleteTimeseries

deleteTimeseries

setStorageGroup

deleteStorageGroups

setTTL

getDeviceNodeWithAutoCreate

getDeviceNodeWithAutoCreate

isPathExist

getMetadataInString

getTotalNormalSeriesNumber

getTotalTemplateSeriesNumber

getAllTimeseriesCount

getAllTimeseriesCount

getDevicesNum

getDevicesNum

getStorageGroupNum

getNodesCountInGivenLevel

getNodesCountInGivenLevel

getMeasurementCountGroupByLevel

getNodesListInGivenLevel

getNodesListInGivenLevel

getChildNodePathInNextLevel

getChildNodePathInNextLevel

getChildNodeNameInNextLevel

getChildNodeNameInNextLevel

isStorageGroup

checkStorageGroupByPath

getBelongedStorageGroup

getBelongedStorageGroups

getMatchedStorageGroups

getAllStorageGroupPaths

getStorageGroupsTTL

getBelongedDevices

getMatchedDevices

getMatchedDevices

getMeasurementPaths

getMeasurementPaths

getMeasurementPathsWithAlias

showTimeseries

getSeriesType

getSeriesSchema

getAllMeasurementByDevicePath

getAllMeasurementSchemaByPrefix

getStorageGroupNodeByStorageGroupPath

getStorageGroupNodeByPath

getAllStorageGroupNodes

getDeviceNode

getMeasurementMNodes

getMeasurementMNode

getMeasurementMNode

changeOffset

changeAlias

upsertTagsAndAttributes

addAttributes

addTags

dropTagsOrAttributes

setTagsOrAttributesValue