HTHou commented on a change in pull request #1721: URL: https://github.com/apache/iotdb/pull/1721#discussion_r530045640
########## File path: docs/UserGuide/System Tools/MLogParser Tool.md ########## @@ -0,0 +1,37 @@ +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +--> + +# What + +After version 0.12.x, IoTDB encodes metadata files into binary format. + +If you want to parse metadata into a human readable way, you can use this tool to parse the specified metadata file. + +The tool can parse snapshot files and mlog files. + +# How to use + +Linux/MacOS +> ./mLogParser.sh -f /your path/mlog.bin -o \your path\mlog.txt Review comment: It should be `./mLogParser.sh -f /your path/mlog.bin -o /your path/mlog.txt`? ########## File path: server/src/main/java/org/apache/iotdb/db/metadata/logfile/MLogWriter.java ########## @@ -0,0 +1,424 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.iotdb.db.metadata.logfile; + +import org.apache.commons.io.FileUtils; +import org.apache.iotdb.db.conf.IoTDBDescriptor; +import org.apache.iotdb.db.engine.fileSystem.SystemFileFactory; +import org.apache.iotdb.db.exception.metadata.MetadataException; +import org.apache.iotdb.db.metadata.MetadataConstant; +import org.apache.iotdb.db.metadata.MetadataOperationType; +import org.apache.iotdb.db.metadata.PartialPath; +import org.apache.iotdb.db.metadata.mnode.MNode; +import org.apache.iotdb.db.metadata.mnode.MeasurementMNode; +import org.apache.iotdb.db.metadata.mnode.StorageGroupMNode; +import org.apache.iotdb.db.qp.physical.PhysicalPlan; +import org.apache.iotdb.db.qp.physical.sys.ChangeAliasPlan; +import org.apache.iotdb.db.qp.physical.sys.ChangeTagOffsetPlan; +import org.apache.iotdb.db.qp.physical.sys.CreateTimeSeriesPlan; +import org.apache.iotdb.db.qp.physical.sys.DeleteStorageGroupPlan; +import org.apache.iotdb.db.qp.physical.sys.DeleteTimeSeriesPlan; +import org.apache.iotdb.db.qp.physical.sys.MNodePlan; +import org.apache.iotdb.db.qp.physical.sys.MeasurementMNodePlan; +import org.apache.iotdb.db.qp.physical.sys.SetStorageGroupPlan; +import org.apache.iotdb.db.qp.physical.sys.SetTTLPlan; +import org.apache.iotdb.db.qp.physical.sys.StorageGroupMNodePlan; +import org.apache.iotdb.db.writelog.io.LogWriter; +import org.apache.iotdb.tsfile.file.metadata.enums.CompressionType; +import org.apache.iotdb.tsfile.file.metadata.enums.TSDataType; +import org.apache.iotdb.tsfile.file.metadata.enums.TSEncoding; +import org.apache.iotdb.tsfile.fileSystem.FSFactoryProducer; +import org.apache.iotdb.tsfile.write.schema.MeasurementSchema; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.File; +import java.io.IOException; +import java.nio.BufferOverflowException; +import java.nio.ByteBuffer; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +public class MLogWriter implements AutoCloseable { + + private static final Logger logger = LoggerFactory.getLogger(MLogWriter.class); + private File logFile; + private LogWriter logWriter; + private int logNum; + private ByteBuffer mlogBuffer = ByteBuffer.allocate( + IoTDBDescriptor.getInstance().getConfig().getMlogBufferSize()); + + // we write log to channel every time, so we need not to call channel.force every time + private static final long DUMMY_FLUSH_TIME = 100; + private static final String LOG_TOO_LARGE_INFO = "Log cannot fit into buffer, please increase mlog_buffer_size"; + + public MLogWriter(String schemaDir, String logFileName) throws IOException { + File metadataDir = SystemFileFactory.INSTANCE.getFile(schemaDir); + if (!metadataDir.exists()) { + if (metadataDir.mkdirs()) { + logger.info("create schema folder {}.", metadataDir); + } else { + logger.warn("create schema folder {} failed.", metadataDir); + } + } + + logFile = SystemFileFactory.INSTANCE.getFile(schemaDir + File.separator + logFileName); + logWriter = new LogWriter(logFile, DUMMY_FLUSH_TIME); + } + + public MLogWriter(String logFilePath) throws IOException { + logFile = SystemFileFactory.INSTANCE.getFile(logFilePath); + logWriter = new LogWriter(logFile, DUMMY_FLUSH_TIME); + } + + @Override + public void close() throws IOException { + logWriter.close(); + } + + private void sync() { + try { + logWriter.write(mlogBuffer); + } catch (IOException e) { + logger.error("MLog {} sync failed, change system mode to read-only", logFile.getAbsoluteFile(), e); + IoTDBDescriptor.getInstance().getConfig().setReadOnly(true); + } + mlogBuffer.clear(); + } + + private void putLog(PhysicalPlan plan) { + try { + plan.serialize(mlogBuffer); + sync(); + logNum ++; + } catch (BufferOverflowException e) { + logger.warn("MLog {} BufferOverflow !", plan.getOperatorType(), e); + } + } + + public void createTimeseries(CreateTimeSeriesPlan createTimeSeriesPlan) throws IOException { + try { + putLog(createTimeSeriesPlan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void deleteTimeseries(DeleteTimeSeriesPlan deleteTimeSeriesPlan) throws IOException { + try { + putLog(deleteTimeSeriesPlan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void setStorageGroup(PartialPath storageGroup) throws IOException { + try { + SetStorageGroupPlan plan = new SetStorageGroupPlan(storageGroup); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void deleteStorageGroup(PartialPath storageGroup) throws IOException { + try { + DeleteStorageGroupPlan plan = new DeleteStorageGroupPlan(Collections.singletonList(storageGroup)); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void setTTL(PartialPath storageGroup, long ttl) throws IOException { + try { + SetTTLPlan plan = new SetTTLPlan(storageGroup, ttl); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void changeOffset(PartialPath path, long offset) throws IOException { + try { + ChangeTagOffsetPlan plan = new ChangeTagOffsetPlan(path, offset); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void changeAlias(PartialPath path, String alias) throws IOException { + try { + ChangeAliasPlan plan = new ChangeAliasPlan(path, alias); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void serializeMNode(MNode node) throws IOException { + try { + int childSize = 0; + if (node.getChildren() != null) { + childSize = node.getChildren().size(); + } + MNodePlan plan = new MNodePlan(node.getName(), childSize); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void serializeMeasurementMNode(MeasurementMNode node) throws IOException { + try { + int childSize = 0; + if (node.getChildren() != null) { + childSize = node.getChildren().size(); + } + MeasurementMNodePlan plan = new MeasurementMNodePlan(node.getName(), node.getAlias(), + node.getOffset(), childSize, node.getSchema()); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void serializeStorageGroupMNode(StorageGroupMNode node) throws IOException { + try { + int childSize = 0; + if (node.getChildren() != null) { + childSize = node.getChildren().size(); + } + StorageGroupMNodePlan plan = new StorageGroupMNodePlan(node.getName(), node.getDataTTL(), childSize); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public static void upgradeTxtToBin(String schemaDir, String oldFileName, + String newFileName, boolean isSnapshot) throws IOException { + File logFile = SystemFileFactory.INSTANCE.getFile(schemaDir + File.separator + newFileName); + File tmpLogFile = SystemFileFactory.INSTANCE.getFile(logFile.getAbsolutePath() + ".tmp"); + File oldLogFile = SystemFileFactory.INSTANCE.getFile( + schemaDir + File.separator + oldFileName); + File tmpOldLogFile = SystemFileFactory.INSTANCE.getFile(oldLogFile.getAbsolutePath() + + ".tmp"); + + if (oldLogFile.exists() || tmpOldLogFile.exists()) { + + if (tmpOldLogFile.exists() && !oldLogFile.exists()) { + FileUtils.moveFile(tmpOldLogFile, oldLogFile); + } + + try (MLogWriter mLogWriter = new MLogWriter(schemaDir, newFileName + ".tmp"); + MLogTxtReader mLogTxtReader = new MLogTxtReader(schemaDir, oldFileName)) { + // upgrade from old character log file to new binary mlog + while (mLogTxtReader.hasNext()) { + String cmd = mLogTxtReader.next(); + try { + mLogWriter.operation(cmd, isSnapshot); + } catch (MetadataException e) { + logger.error("failed to upgrade cmd {}.", cmd, e); + } + } + } + } else if (!logFile.exists() && !tmpLogFile.exists()) { + // if both .bin and .bin.tmp do not exist, nothing to do + } else if (!logFile.exists() && tmpLogFile.exists()) { + // if old .bin doesn't exist but .bin.tmp exists, rename tmp file to .bin + FSFactoryProducer.getFSFactory().moveFile(tmpLogFile, logFile); + } else if (tmpLogFile.exists()) { + // if both .bin and .bin.tmp exist, delete .bin.tmp + try { + Files.delete(Paths.get(tmpLogFile.toURI())); + } catch (IOException e) { + throw new IOException("Deleting " + tmpLogFile + "failed with exception " + e.getMessage()); + } + } + + // do some clean job + // remove old .txt and .txt.tmp + if (oldLogFile.exists()) { + try { + Files.delete(Paths.get(oldLogFile.toURI())); + } catch (IOException e) { + throw new IOException("Deleting " + oldLogFile + "failed with exception " + e.getMessage()); + } + } + + if (tmpOldLogFile.exists()) { + try { + Files.delete(Paths.get(tmpOldLogFile.toURI())); + } catch (IOException e) { + throw new IOException("Deleting " + tmpOldLogFile + "failed with exception " + e.getMessage()); + } + } + + // rename .bin.tmp to .bin + FSFactoryProducer.getFSFactory().moveFile(tmpLogFile, logFile); + } + + public static void upgradeMLog() throws IOException { + String schemaDir = IoTDBDescriptor.getInstance().getConfig().getSchemaDir(); + upgradeTxtToBin(schemaDir, MetadataConstant.METADATA_TXT_LOG, MetadataConstant.METADATA_LOG, false); + upgradeTxtToBin(schemaDir, MetadataConstant.MTREE_TXT_SNAPSHOT, MetadataConstant.MTREE_SNAPSHOT, true); + } + + public void clear() throws IOException { + sync(); + logWriter.close(); + mlogBuffer.clear(); + if (logFile != null && logFile.exists()) { + Files.delete(logFile.toPath()); + } + logNum = 0; + logWriter = new LogWriter(logFile, 0L); + } + + public int getLogNum() { + return logNum; + } + + /** + * only used for initialize a mlog file writer. + */ + public void setLogNum(int number) { + logNum = number; + } + + public void operation(String cmd, boolean isSnapshot) throws IOException, MetadataException { + if (!isSnapshot) { + operation(cmd); + } else { + PhysicalPlan plan = convertFromString(cmd); + try { + if (plan != null) { + putLog(plan); + } + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + } + + /** + * upgrade from mlog.txt to mlog.bin + * @param cmd, the old meta operation + * @throws IOException + * @throws MetadataException + */ + public void operation(String cmd) throws IOException, MetadataException { + // see createTimeseries() to get the detailed format of the cmd + String[] args = cmd.trim().split(",", -1); + switch (args[0]) { + case MetadataOperationType.CREATE_TIMESERIES: Review comment: If there is a comma in the path of a timeseries, the length of args[] will be larger than 8. I think adding these lines back is better. ``` if (args.length > 8) { String[] tmpArgs = new String[8]; tmpArgs[0] = args[0]; int i = 1; tmpArgs[1] = ""; for (; i < args.length - 7; i++) { tmpArgs[1] += args[i] + ","; } tmpArgs[1] += args[i++]; for (int j = 2; j < 8; j++) { tmpArgs[j] = args[i++]; } args = tmpArgs; } ``` ########## File path: server/src/main/java/org/apache/iotdb/db/conf/IoTDBConfigCheck.java ########## @@ -184,51 +185,16 @@ public void checkConfig() throws IOException { inputStream, TSFileConfig.STRING_CHARSET)) { properties.load(inputStreamReader); } - // check whether upgrading from v0.9 to v0.11 Review comment: Agree with @samperson1997 ########## File path: server/src/main/java/org/apache/iotdb/db/metadata/logfile/MLogWriter.java ########## @@ -0,0 +1,424 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.iotdb.db.metadata.logfile; + +import org.apache.commons.io.FileUtils; +import org.apache.iotdb.db.conf.IoTDBDescriptor; +import org.apache.iotdb.db.engine.fileSystem.SystemFileFactory; +import org.apache.iotdb.db.exception.metadata.MetadataException; +import org.apache.iotdb.db.metadata.MetadataConstant; +import org.apache.iotdb.db.metadata.MetadataOperationType; +import org.apache.iotdb.db.metadata.PartialPath; +import org.apache.iotdb.db.metadata.mnode.MNode; +import org.apache.iotdb.db.metadata.mnode.MeasurementMNode; +import org.apache.iotdb.db.metadata.mnode.StorageGroupMNode; +import org.apache.iotdb.db.qp.physical.PhysicalPlan; +import org.apache.iotdb.db.qp.physical.sys.ChangeAliasPlan; +import org.apache.iotdb.db.qp.physical.sys.ChangeTagOffsetPlan; +import org.apache.iotdb.db.qp.physical.sys.CreateTimeSeriesPlan; +import org.apache.iotdb.db.qp.physical.sys.DeleteStorageGroupPlan; +import org.apache.iotdb.db.qp.physical.sys.DeleteTimeSeriesPlan; +import org.apache.iotdb.db.qp.physical.sys.MNodePlan; +import org.apache.iotdb.db.qp.physical.sys.MeasurementMNodePlan; +import org.apache.iotdb.db.qp.physical.sys.SetStorageGroupPlan; +import org.apache.iotdb.db.qp.physical.sys.SetTTLPlan; +import org.apache.iotdb.db.qp.physical.sys.StorageGroupMNodePlan; +import org.apache.iotdb.db.writelog.io.LogWriter; +import org.apache.iotdb.tsfile.file.metadata.enums.CompressionType; +import org.apache.iotdb.tsfile.file.metadata.enums.TSDataType; +import org.apache.iotdb.tsfile.file.metadata.enums.TSEncoding; +import org.apache.iotdb.tsfile.fileSystem.FSFactoryProducer; +import org.apache.iotdb.tsfile.write.schema.MeasurementSchema; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.File; +import java.io.IOException; +import java.nio.BufferOverflowException; +import java.nio.ByteBuffer; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +public class MLogWriter implements AutoCloseable { + + private static final Logger logger = LoggerFactory.getLogger(MLogWriter.class); + private File logFile; + private LogWriter logWriter; + private int logNum; + private ByteBuffer mlogBuffer = ByteBuffer.allocate( + IoTDBDescriptor.getInstance().getConfig().getMlogBufferSize()); + + // we write log to channel every time, so we need not to call channel.force every time + private static final long DUMMY_FLUSH_TIME = 100; + private static final String LOG_TOO_LARGE_INFO = "Log cannot fit into buffer, please increase mlog_buffer_size"; + + public MLogWriter(String schemaDir, String logFileName) throws IOException { + File metadataDir = SystemFileFactory.INSTANCE.getFile(schemaDir); + if (!metadataDir.exists()) { + if (metadataDir.mkdirs()) { + logger.info("create schema folder {}.", metadataDir); + } else { + logger.warn("create schema folder {} failed.", metadataDir); + } + } + + logFile = SystemFileFactory.INSTANCE.getFile(schemaDir + File.separator + logFileName); + logWriter = new LogWriter(logFile, DUMMY_FLUSH_TIME); + } + + public MLogWriter(String logFilePath) throws IOException { + logFile = SystemFileFactory.INSTANCE.getFile(logFilePath); + logWriter = new LogWriter(logFile, DUMMY_FLUSH_TIME); + } + + @Override + public void close() throws IOException { + logWriter.close(); + } + + private void sync() { + try { + logWriter.write(mlogBuffer); + } catch (IOException e) { + logger.error("MLog {} sync failed, change system mode to read-only", logFile.getAbsoluteFile(), e); + IoTDBDescriptor.getInstance().getConfig().setReadOnly(true); + } + mlogBuffer.clear(); + } + + private void putLog(PhysicalPlan plan) { + try { + plan.serialize(mlogBuffer); + sync(); + logNum ++; + } catch (BufferOverflowException e) { + logger.warn("MLog {} BufferOverflow !", plan.getOperatorType(), e); + } + } + + public void createTimeseries(CreateTimeSeriesPlan createTimeSeriesPlan) throws IOException { + try { + putLog(createTimeSeriesPlan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void deleteTimeseries(DeleteTimeSeriesPlan deleteTimeSeriesPlan) throws IOException { + try { + putLog(deleteTimeSeriesPlan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void setStorageGroup(PartialPath storageGroup) throws IOException { + try { + SetStorageGroupPlan plan = new SetStorageGroupPlan(storageGroup); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void deleteStorageGroup(PartialPath storageGroup) throws IOException { + try { + DeleteStorageGroupPlan plan = new DeleteStorageGroupPlan(Collections.singletonList(storageGroup)); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void setTTL(PartialPath storageGroup, long ttl) throws IOException { + try { + SetTTLPlan plan = new SetTTLPlan(storageGroup, ttl); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void changeOffset(PartialPath path, long offset) throws IOException { + try { + ChangeTagOffsetPlan plan = new ChangeTagOffsetPlan(path, offset); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void changeAlias(PartialPath path, String alias) throws IOException { + try { + ChangeAliasPlan plan = new ChangeAliasPlan(path, alias); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void serializeMNode(MNode node) throws IOException { + try { + int childSize = 0; + if (node.getChildren() != null) { + childSize = node.getChildren().size(); + } + MNodePlan plan = new MNodePlan(node.getName(), childSize); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void serializeMeasurementMNode(MeasurementMNode node) throws IOException { + try { + int childSize = 0; + if (node.getChildren() != null) { + childSize = node.getChildren().size(); + } + MeasurementMNodePlan plan = new MeasurementMNodePlan(node.getName(), node.getAlias(), + node.getOffset(), childSize, node.getSchema()); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public void serializeStorageGroupMNode(StorageGroupMNode node) throws IOException { + try { + int childSize = 0; + if (node.getChildren() != null) { + childSize = node.getChildren().size(); + } + StorageGroupMNodePlan plan = new StorageGroupMNodePlan(node.getName(), node.getDataTTL(), childSize); + putLog(plan); + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + + public static void upgradeTxtToBin(String schemaDir, String oldFileName, + String newFileName, boolean isSnapshot) throws IOException { + File logFile = SystemFileFactory.INSTANCE.getFile(schemaDir + File.separator + newFileName); + File tmpLogFile = SystemFileFactory.INSTANCE.getFile(logFile.getAbsolutePath() + ".tmp"); + File oldLogFile = SystemFileFactory.INSTANCE.getFile( + schemaDir + File.separator + oldFileName); + File tmpOldLogFile = SystemFileFactory.INSTANCE.getFile(oldLogFile.getAbsolutePath() + + ".tmp"); + + if (oldLogFile.exists() || tmpOldLogFile.exists()) { + + if (tmpOldLogFile.exists() && !oldLogFile.exists()) { + FileUtils.moveFile(tmpOldLogFile, oldLogFile); + } + + try (MLogWriter mLogWriter = new MLogWriter(schemaDir, newFileName + ".tmp"); + MLogTxtReader mLogTxtReader = new MLogTxtReader(schemaDir, oldFileName)) { + // upgrade from old character log file to new binary mlog + while (mLogTxtReader.hasNext()) { + String cmd = mLogTxtReader.next(); + try { + mLogWriter.operation(cmd, isSnapshot); + } catch (MetadataException e) { + logger.error("failed to upgrade cmd {}.", cmd, e); + } + } + } + } else if (!logFile.exists() && !tmpLogFile.exists()) { + // if both .bin and .bin.tmp do not exist, nothing to do + } else if (!logFile.exists() && tmpLogFile.exists()) { + // if old .bin doesn't exist but .bin.tmp exists, rename tmp file to .bin + FSFactoryProducer.getFSFactory().moveFile(tmpLogFile, logFile); + } else if (tmpLogFile.exists()) { + // if both .bin and .bin.tmp exist, delete .bin.tmp + try { + Files.delete(Paths.get(tmpLogFile.toURI())); + } catch (IOException e) { + throw new IOException("Deleting " + tmpLogFile + "failed with exception " + e.getMessage()); + } + } + + // do some clean job + // remove old .txt and .txt.tmp + if (oldLogFile.exists()) { + try { + Files.delete(Paths.get(oldLogFile.toURI())); + } catch (IOException e) { + throw new IOException("Deleting " + oldLogFile + "failed with exception " + e.getMessage()); + } + } + + if (tmpOldLogFile.exists()) { + try { + Files.delete(Paths.get(tmpOldLogFile.toURI())); + } catch (IOException e) { + throw new IOException("Deleting " + tmpOldLogFile + "failed with exception " + e.getMessage()); + } + } + + // rename .bin.tmp to .bin + FSFactoryProducer.getFSFactory().moveFile(tmpLogFile, logFile); + } + + public static void upgradeMLog() throws IOException { + String schemaDir = IoTDBDescriptor.getInstance().getConfig().getSchemaDir(); + upgradeTxtToBin(schemaDir, MetadataConstant.METADATA_TXT_LOG, MetadataConstant.METADATA_LOG, false); + upgradeTxtToBin(schemaDir, MetadataConstant.MTREE_TXT_SNAPSHOT, MetadataConstant.MTREE_SNAPSHOT, true); + } + + public void clear() throws IOException { + sync(); + logWriter.close(); + mlogBuffer.clear(); + if (logFile != null && logFile.exists()) { + Files.delete(logFile.toPath()); + } + logNum = 0; + logWriter = new LogWriter(logFile, 0L); + } + + public int getLogNum() { + return logNum; + } + + /** + * only used for initialize a mlog file writer. + */ + public void setLogNum(int number) { + logNum = number; + } + + public void operation(String cmd, boolean isSnapshot) throws IOException, MetadataException { + if (!isSnapshot) { + operation(cmd); + } else { + PhysicalPlan plan = convertFromString(cmd); + try { + if (plan != null) { + putLog(plan); + } + } catch (BufferOverflowException e) { + throw new IOException( + LOG_TOO_LARGE_INFO, e); + } + } + } + + /** + * upgrade from mlog.txt to mlog.bin + * @param cmd, the old meta operation + * @throws IOException + * @throws MetadataException + */ + public void operation(String cmd) throws IOException, MetadataException { + // see createTimeseries() to get the detailed format of the cmd + String[] args = cmd.trim().split(",", -1); + switch (args[0]) { + case MetadataOperationType.CREATE_TIMESERIES: + Map<String, String> props = null; + if (!args[5].isEmpty()) { + String[] keyValues = args[5].split("&"); + String[] kv; + props = new HashMap<>(); + for (String keyValue : keyValues) { + kv = keyValue.split("="); + props.put(kv[0], kv[1]); + } + } + + String alias = null; + if (!args[6].isEmpty()) { + alias = args[6]; + } + long offset = -1L; + if (!args[7].isEmpty()) { + offset = Long.parseLong(args[7]); + } + + CreateTimeSeriesPlan plan = new CreateTimeSeriesPlan(new PartialPath(args[1]), + TSDataType.deserialize(Short.parseShort(args[2])), + TSEncoding.deserialize(Short.parseShort(args[3])), + CompressionType.deserialize(Short.parseShort(args[4])), props, null, null, alias); + plan.setTagOffset(offset); + + createTimeseries(plan); + break; + case MetadataOperationType.DELETE_TIMESERIES: Review comment: Same reason. Add these lines. ``` if (args.length > 2) { StringBuilder tmp = new StringBuilder(); for (int i = 1; i < args.length - 1; i++) { tmp.append(args[i]).append(","); } tmp.append(args[args.length - 1]); args[1] = tmp.toString(); } ``` ########## File path: docs/zh/UserGuide/System Tools/MLogParser Tool.md ########## @@ -0,0 +1,37 @@ +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +--> + +# 工具说明 + +0.12.x版本之后，IoTDB将元数据文件编码成二进制。 + +如果想要解析元数据成人可读的方式，可以使用本工具来解析指定元数据文件。 + +该工具可以同时解析snapshot文件和mlog文件。 + +# 使用方式 + +Linux/MacOS +> ./mLogParser.sh -f /your path/mlog.bin -o \your path\mlog.txt Review comment: Same as above ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
