| import{_ as e,O as i,P as t,ah as n,aW as l}from"./framework-e4340ccd.js";const s={},a=l(`<h1 id="sql-reference" tabindex="-1"><a class="header-anchor" href="#sql-reference" aria-hidden="true">#</a> SQL Reference</h1><p>In this part, we will introduce you IoTDB's Query Language. IoTDB offers you a SQL-like query language for interacting with IoTDB, the query language can be devided into 4 major parts:</p><ul><li>Schema Statement: statements about schema management are all listed in this section.</li><li>Data Management Statement: statements about data management (such as: data insertion, data query, etc.) are all listed in this section.</li><li>Database Management Statement: statements about database management and authentication are all listed in this section.</li><li>Functions: functions that IoTDB offers are all listed in this section.</li></ul><p>All of these statements are write in IoTDB's own syntax, for details about the syntax composition, please check the <code>Reference</code> section.</p><h2 id="show-version" tabindex="-1"><a class="header-anchor" href="#show-version" aria-hidden="true">#</a> Show Version</h2><div class="language-sql line-numbers-mode" data-ext="sql"><pre class="language-sql"><code><span class="token keyword">show</span> version |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>+---------------+ |
| | version| |
| +---------------+ |
| |1.0.0| |
| +---------------+ |
| Total line number = 1 |
| It costs 0.417s |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="schema-statement" tabindex="-1"><a class="header-anchor" href="#schema-statement" aria-hidden="true">#</a> Schema Statement</h2><ul><li>Create Database</li></ul><div class="language-SQL line-numbers-mode" data-ext="SQL"><pre class="language-SQL"><code>CREATE DATABASE <FullPath> |
| Eg: IoTDB > CREATE DATABASE root.ln.wf01.wt01 |
| Note: FullPath can not include wildcard \`*\` or \`**\` |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Delete database</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>DELETE DATABASE <PathPattern> [COMMA <PathPattern>]* |
| Eg: IoTDB > DELETE DATABASE root.ln.wf01.wt01 |
| Eg: IoTDB > DELETE DATABASE root.ln.wf01.wt01, root.ln.wf01.wt02 |
| Eg: IoTDB > DELETE DATABASE root.ln.wf01.* |
| Eg: IoTDB > DELETE DATABASE root.** |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Create Timeseries Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>CREATE TIMESERIES <FullPath> WITH <AttributeClauses> |
| alias |
| : LR_BRACKET ID RR_BRACKET |
| ; |
| attributeClauses |
| : DATATYPE OPERATOR_EQ <DataTypeValue> |
| COMMA ENCODING OPERATOR_EQ <EncodingValue> |
| (COMMA (COMPRESSOR | COMPRESSION) OPERATOR_EQ <CompressorValue>)? |
| (COMMA property)* |
| tagClause |
| attributeClause |
| ; |
| attributeClause |
| : ATTRIBUTES LR_BRACKET propertyClause (COMMA propertyClause)* RR_BRACKET |
| ; |
| tagClause |
| : TAGS LR_BRACKET propertyClause (COMMA propertyClause)* RR_BRACKET |
| ; |
| propertyClause |
| : name=ID OPERATOR_EQ propertyValue |
| ; |
| DataTypeValue: BOOLEAN | DOUBLE | FLOAT | INT32 | INT64 | TEXT |
| EncodingValue: GORILLA | PLAIN | RLE | TS_2DIFF | REGULAR |
| CompressorValue: UNCOMPRESSED | SNAPPY |
| AttributesType: SDT | COMPDEV | COMPMINTIME | COMPMAXTIME |
| PropertyValue: ID | constant |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.status WITH DATATYPE=BOOLEAN, ENCODING=PLAIN |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature WITH DATATYPE=FLOAT, ENCODING=RLE |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature WITH DATATYPE=FLOAT, ENCODING=RLE, COMPRESSOR=SNAPPY, MAX_POINT_NUMBER=3 |
| Eg: CREATE TIMESERIES root.turbine.d0.s0(temperature) WITH DATATYPE=FLOAT, ENCODING=RLE, COMPRESSOR=SNAPPY tags(unit=f, description='turbine this is a test1') attributes(H_Alarm=100, M_Alarm=50) |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature WITH DATATYPE=FLOAT, ENCODING=RLE, DEADBAND=SDT, COMPDEV=0.01 |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature WITH DATATYPE=FLOAT, ENCODING=RLE, DEADBAND=SDT, COMPDEV=0.01, COMPMINTIME=3 |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature WITH DATATYPE=FLOAT, ENCODING=RLE, DEADBAND=SDT, COMPDEV=0.01, COMPMINTIME=2, COMPMAXTIME=15 |
| Note: Datatype and encoding type must be corresponding. Please check Chapter 3 Encoding Section for details. |
| Note: When propertyValue is SDT, it is required to set compression deviation COMPDEV, which is the maximum absolute difference between values. |
| Note: For SDT, values withtin COMPDEV will be discarded. |
| Note: For SDT, it is optional to set compression minimum COMPMINTIME, which is the minimum time difference between stored values for purpose of noise reduction. |
| Note: For SDT, it is optional to set compression maximum COMPMAXTIME, which is the maximum time difference between stored values regardless of COMPDEV. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Create Timeseries Statement (Simplified version, from v0.13)</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>CREATE TIMESERIES <FullPath> <SimplifiedAttributeClauses> |
| SimplifiedAttributeClauses |
| : WITH? (DATATYPE OPERATOR_EQ)? <DataTypeValue> |
| ENCODING OPERATOR_EQ <EncodingValue> |
| ((COMPRESSOR | COMPRESSION) OPERATOR_EQ <CompressorValue>)? |
| (COMMA property)* |
| tagClause |
| attributeClause |
| ; |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.status BOOLEAN ENCODING=PLAIN |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature FLOAT ENCODING=RLE |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature FLOAT ENCODING=RLE COMPRESSOR=SNAPPY MAX_POINT_NUMBER=3 |
| Eg: CREATE TIMESERIES root.turbine.d0.s0(temperature) FLOAT ENCODING=RLE COMPRESSOR=SNAPPY tags(unit=f, description='turbine this is a test1') attributes(H_Alarm=100, M_Alarm=50) |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature FLOAT ENCODING=RLE DEADBAND=SDT COMPDEV=0.01 |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature FLOAT ENCODING=RLE DEADBAND=SDT COMPDEV=0.01 COMPMINTIME=3 |
| Eg: CREATE TIMESERIES root.ln.wf01.wt01.temperature FLOAT ENCODING=RLE DEADBAND=SDT COMPDEV=0.01 COMPMINTIME=2 COMPMAXTIME=15 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Create Aligned Timeseries Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>CREATE ALIGNED TIMESERIES <FullPath> alignedMeasurements |
| alignedMeasurements |
| : LR_BRACKET nodeNameWithoutWildcard attributeClauses |
| (COMMA nodeNameWithoutWildcard attributeClauses)+ RR_BRACKET |
| ; |
| Eg: CREATE ALIGNED TIMESERIES root.ln.wf01.GPS(lat FLOAT ENCODING=GORILLA, lon FLOAT ENCODING=GORILLA COMPRESSOR=SNAPPY) |
| Note: It is not supported to set different compression for a group of aligned timeseries. |
| Note: It is not currently supported to set an alias, tag, and attribute for aligned timeseries. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Create Schema Template Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>CREATE SCHEMA TEMPLATE <TemplateName> LR_BRACKET <TemplateMeasurementClause> (COMMA plateMeasurementClause>)* RR_BRACKET |
| templateMeasurementClause |
| : suffixPath attributeClauses #nonAlignedTemplateMeasurement |
| | suffixPath LR_BRACKET nodeNameWithoutWildcard attributeClauses |
| (COMMA nodeNameWithoutWildcard attributeClauses)+ RR_BRACKET #alignedTemplateMeasurement |
| ; |
| Eg: CREATE SCHEMA TEMPLATE temp1( |
| s1 INT32 encoding=Gorilla, compression=SNAPPY, |
| vector1( |
| s1 INT32 encoding=Gorilla, |
| s2 FLOAT encoding=RLE, compression=SNAPPY) |
| ) |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Set Schema Template Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SET SCHEMA TEMPLATE <TemplateName> TO <PrefixPath> |
| Eg: SET SCHEMA TEMPLATE temp1 TO root.beijing |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Create Timeseries Of Schema Template Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>CREATE TIMESERIES OF SCHEMA TEMPLATE ON <PrefixPath> |
| Eg: CREATE TIMESERIES OF SCHEMA TEMPLATE ON root.beijing |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Unset Schema Template Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>UNSET SCHEMA TEMPLATE <TemplateName> FROM <PrefixPath> |
| Eg: UNSET SCHEMA TEMPLATE temp1 FROM root.beijing |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Delete Timeseries Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>(DELETE | DROP) TIMESERIES <PathPattern> [COMMA <PathPattern>]* |
| Eg: IoTDB > DELETE TIMESERIES root.ln.wf01.wt01.status |
| Eg: IoTDB > DELETE TIMESERIES root.ln.wf01.wt01.status, root.ln.wf01.wt01.temperature |
| Eg: IoTDB > DELETE TIMESERIES root.ln.wf01.wt01.* |
| Eg: IoTDB > DROP TIMESERIES root.ln.wf01.wt01.* |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Alter Timeseries Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>ALTER TIMESERIES fullPath alterClause |
| alterClause |
| : RENAME beforeName=ID TO currentName=ID |
| | SET property (COMMA property)* |
| | DROP ID (COMMA ID)* |
| | ADD TAGS property (COMMA property)* |
| | ADD ATTRIBUTES property (COMMA property)* |
| | UPSERT tagClause attributeClause |
| ; |
| attributeClause |
| : (ATTRIBUTES LR_BRACKET property (COMMA property)* RR_BRACKET)? |
| ; |
| tagClause |
| : (TAGS LR_BRACKET property (COMMA property)* RR_BRACKET)? |
| ; |
| Eg: ALTER timeseries root.turbine.d1.s1 RENAME tag1 TO newTag1 |
| Eg: ALTER timeseries root.turbine.d1.s1 SET tag1=newV1, attr1=newV1 |
| Eg: ALTER timeseries root.turbine.d1.s1 DROP tag1, tag2 |
| Eg: ALTER timeseries root.turbine.d1.s1 ADD TAGS tag3=v3, tag4=v4 |
| Eg: ALTER timeseries root.turbine.d1.s1 ADD ATTRIBUTES attr3=v3, attr4=v4 |
| EG: ALTER timeseries root.turbine.d1.s1 UPSERT TAGS(tag2=newV2, tag3=v3) ATTRIBUTES(attr3=v3, attr4=v4) |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show All Timeseries Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW TIMESERIES |
| Eg: IoTDB > SHOW TIMESERIES |
| Note: This statement can only be used in IoTDB Client. If you need to show all timeseries in JDBC, please use \`DataBaseMetadata\` interface. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show Specific Timeseries Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW TIMESERIES <Path> |
| Eg: IoTDB > SHOW TIMESERIES root.** |
| Eg: IoTDB > SHOW TIMESERIES root.ln.** |
| Eg: IoTDB > SHOW TIMESERIES root.ln.*.*.status |
| Eg: IoTDB > SHOW TIMESERIES root.ln.wf01.wt01.status |
| Note: The path can be timeseries path or path pattern. |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show Specific Timeseries Statement with where clause</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW TIMESERIES pathPattern? showWhereClause? |
| showWhereClause |
| : WHERE (property | containsExpression) |
| ; |
| containsExpression |
| : name=ID OPERATOR_CONTAINS value=propertyValue |
| ; |
| |
| Eg: show timeseries root.ln.** where unit='c' |
| Eg: show timeseries root.ln.** where description contains 'test1' |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show Specific Timeseries Statement with where clause start from offset and limit the total number of result</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW TIMESERIES pathPattern? showWhereClause? limitClause? |
| |
| showWhereClause |
| : WHERE (property | containsExpression) |
| ; |
| containsExpression |
| : name=ID OPERATOR_CONTAINS value=propertyValue |
| ; |
| limitClause |
| : LIMIT INT offsetClause? |
| | offsetClause? LIMIT INT |
| ; |
| |
| Eg: show timeseries root.ln.** where unit='c' |
| Eg: show timeseries root.ln.** where description contains 'test1' |
| Eg: show timeseries root.ln.** where unit='c' limit 10 offset 10 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show Databases Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW DATABASES |
| Eg: IoTDB > SHOW DATABASES |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show Specific database Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW DATABASES <Path> |
| Eg: IoTDB > SHOW DATABASES root.* |
| Eg: IoTDB > SHOW DATABASES root.ln |
| Note: The path can be full path or path pattern. |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show Merge Status Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW MERGE INFO |
| Eg: IoTDB > SHOW MERGE INFO |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Count Timeseries Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>COUNT TIMESERIES <Path> |
| Eg: IoTDB > COUNT TIMESERIES root.** |
| Eg: IoTDB > COUNT TIMESERIES root.ln.** |
| Eg: IoTDB > COUNT TIMESERIES root.ln.*.*.status |
| Eg: IoTDB > COUNT TIMESERIES root.ln.wf01.wt01.status |
| Note: The path can be timeseries path or path pattern. |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>COUNT TIMESERIES <Path> GROUP BY LEVEL=<INTEGER> |
| Eg: IoTDB > COUNT TIMESERIES root.** GROUP BY LEVEL=1 |
| Eg: IoTDB > COUNT TIMESERIES root.ln.** GROUP BY LEVEL=2 |
| Eg: IoTDB > COUNT TIMESERIES root.ln.wf01.* GROUP BY LEVEL=3 |
| Note: The path can be timeseries path or path pattern. |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Count Nodes Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>COUNT NODES <Path> LEVEL=<INTEGER> |
| Eg: IoTDB > COUNT NODES root.** LEVEL=2 |
| Eg: IoTDB > COUNT NODES root.ln.** LEVEL=2 |
| Eg: IoTDB > COUNT NODES root.ln.* LEVEL=3 |
| Eg: IoTDB > COUNT NODES root.ln.wf01 LEVEL=3 |
| Note: The path can be full path or path pattern. |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show All Devices Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW DEVICES (WITH DATABASE)? limitClause? |
| Eg: IoTDB > SHOW DEVICES |
| Eg: IoTDB > SHOW DEVICES WITH DATABASE |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show Specific Devices Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW DEVICES <PathPattern> (WITH DATABASE)? limitClause? |
| Eg: IoTDB > SHOW DEVICES root.** |
| Eg: IoTDB > SHOW DEVICES root.ln.** |
| Eg: IoTDB > SHOW DEVICES root.*.wf01 |
| Eg: IoTDB > SHOW DEVICES root.ln WITH DATABASE |
| Eg: IoTDB > SHOW DEVICES root.*.wf01 WITH DATABASE |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show Child Paths of Root Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW CHILD PATHS |
| Eg: IoTDB > SHOW CHILD PATHS |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show Child Paths Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW CHILD PATHS <PathPattern> |
| Eg: IoTDB > SHOW CHILD PATHS root |
| Eg: IoTDB > SHOW CHILD PATHS root.ln |
| Eg: IoTDB > SHOW CHILD PATHS root.*.wf01 |
| Eg: IoTDB > SHOW CHILD PATHS root.ln.wf* |
| Note: This statement can be used in IoTDB Client and JDBC. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="data-management-statement" tabindex="-1"><a class="header-anchor" href="#data-management-statement" aria-hidden="true">#</a> Data Management Statement</h2><ul><li>Insert Record Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>INSERT INTO <PrefixPath> LPAREN TIMESTAMP COMMA <Sensor> [COMMA <Sensor>]* RPAREN VALUES LPAREN <TimeValue>, <PointValue> [COMMA <PointValue>]* RPAREN |
| Sensor : Identifier |
| Eg: IoTDB > INSERT INTO root.ln.wf01.wt01(timestamp,status) values(1509465600000,true) |
| Eg: IoTDB > INSERT INTO root.ln.wf01.wt01(timestamp,status) VALUES(NOW(), false) |
| Eg: IoTDB > INSERT INTO root.ln.wf01.wt01(timestamp,temperature) VALUES(2017-11-01T00:17:00.000+08:00,24.22028) |
| Eg: IoTDB > INSERT INTO root.ln.wf01.wt01(timestamp,status,temperature) VALUES (1509466680000,false,20.060787) |
| Eg: IoTDB > INSERT INTO root.sg.d1(timestamp,(s1,s2),(s3,s4)) VALUES (1509466680000,(1.0,2),(NULL,4)) |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| Note: The order of Sensor and PointValue need one-to-one correspondence |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Delete Record Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>DELETE FROM <PathPattern> [COMMA <PathPattern>]* [WHERE <WhereClause>]? |
| WhereClause : <Condition> [(AND) <Condition>]* |
| Condition : <TimeExpr> [(AND) <TimeExpr>]* |
| TimeExpr : TIME PrecedenceEqualOperator (<TimeValue> | <RelativeTime>) |
| Eg: DELETE FROM root.ln.wf01.wt01.temperature WHERE time > 2016-01-05T00:15:00+08:00 and time < 2017-11-1T00:05:00+08:00 |
| Eg: DELETE FROM root.ln.wf01.wt01.status, root.ln.wf01.wt01.temperature WHERE time < NOW() |
| Eg: DELETE FROM root.ln.wf01.wt01.* WHERE time >= 1509466140000 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Select Record Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT <SelectClause> FROM <FromClause> [WHERE <WhereClause>]? |
| SelectClause : <SelectPath> (COMMA <SelectPath>)* |
| SelectPath : <FUNCTION> LPAREN <Path> RPAREN | <Path> |
| FUNCTION : ‘COUNT’ , ‘MIN_TIME’, ‘MAX_TIME’, ‘MIN_VALUE’, ‘MAX_VALUE’ |
| FromClause : <PrefixPath> (COMMA <PrefixPath>)? |
| WhereClause : <Condition> [(AND | OR) <Condition>]* |
| Condition : <Expression> [(AND | OR) <Expression>]* |
| Expression : [NOT | !]? <TimeExpr> | [NOT | !]? <SensorExpr> |
| TimeExpr : TIME PrecedenceEqualOperator (<TimeValue> | <RelativeTime>) |
| RelativeTimeDurationUnit = Integer ('Y'|'MO'|'W'|'D'|'H'|'M'|'S'|'MS'|'US'|'NS') |
| RelativeTime : (now() | <TimeValue>) [(+|-) RelativeTimeDurationUnit]+ |
| SensorExpr : (<Timeseries> | <Path>) PrecedenceEqualOperator <PointValue> |
| Eg: IoTDB > SELECT status, temperature FROM root.ln.wf01.wt01 WHERE temperature < 24 and time > 2017-11-1 0:13:00 |
| Eg. IoTDB > SELECT ** FROM root |
| Eg. IoTDB > SELECT * FROM root.** |
| Eg. IoTDB > SELECT * FROM root.** where time > now() - 5m |
| Eg. IoTDB > SELECT * FROM root.ln.*.wf* |
| Eg. IoTDB > SELECT COUNT(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 25 |
| Eg. IoTDB > SELECT MIN_TIME(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 25 |
| Eg. IoTDB > SELECT MAX_TIME(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature > 24 |
| Eg. IoTDB > SELECT MIN_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature > 23 |
| Eg. IoTDB > SELECT MAX_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 25 |
| Eg. IoTDB > SELECT COUNT(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 25 GROUP BY LEVEL=1 |
| Note: the statement needs to satisfy this constraint: <Path>(SelectClause) + <PrefixPath>(FromClause) = <Timeseries> |
| Note: If the <SensorExpr>(WhereClause) is started with <Path> and not with ROOT, the statement needs to satisfy this constraint: <PrefixPath>(FromClause) + <Path>(SensorExpr) = <Timeseries> |
| Note: In Version 0.7.0, if <WhereClause> includes \`OR\`, time filter can not be used. |
| Note: There must be a space on both sides of the plus and minus operator appearing in the time expression |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Group By Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT <SelectClause> FROM <FromClause> WHERE <WhereClause> GROUP BY <GroupByTimeClause> |
| SelectClause : <Function> [COMMA < Function >]* |
| Function : <AggregationFunction> LPAREN <Path> RPAREN |
| FromClause : <PrefixPath> |
| WhereClause : <Condition> [(AND | OR) <Condition>]* |
| Condition : <Expression> [(AND | OR) <Expression>]* |
| Expression : [NOT | !]? <TimeExpr> | [NOT | !]? <SensorExpr> |
| TimeExpr : TIME PrecedenceEqualOperator (<TimeValue> | <RelativeTime>) |
| RelativeTimeDurationUnit = Integer ('Y'|'MO'|'W'|'D'|'H'|'M'|'S'|'MS'|'US'|'NS') |
| RelativeTime : (now() | <TimeValue>) [(+|-) RelativeTimeDurationUnit]+ |
| SensorExpr : (<Timeseries> | <Path>) PrecedenceEqualOperator <PointValue> |
| GroupByTimeClause : LPAREN <TimeInterval> COMMA <TimeUnit> (COMMA <TimeUnit>)? RPAREN |
| TimeInterval: LSBRACKET <TimeValue> COMMA <TimeValue> RRBRACKET | LRBRACKET <TimeValue> COMMA <TimeValue> RSBRACKET |
| TimeUnit : Integer <DurationUnit> |
| DurationUnit : "ms" | "s" | "m" | "h" | "d" | "w" | "mo" |
| Eg: SELECT COUNT(status), COUNT(temperature) FROM root.ln.wf01.wt01 where temperature < 24 GROUP BY([1509465720000, 1509466380000), 5m) |
| Eg: SELECT COUNT(status), COUNT(temperature) FROM root.ln.wf01.wt01 where temperature < 24 GROUP BY((1509465720000, 1509466380000], 5m) |
| Eg. SELECT COUNT (status), MAX_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE time < 1509466500000 GROUP BY([1509465720000, 1509466380000), 5m, 10m) |
| Eg. SELECT MIN_TIME(status), MIN_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE temperature < 25 GROUP BY ([1509466140000, 1509466380000), 3m, 5ms) |
| Eg. SELECT MIN_TIME(status), MIN_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE temperature < 25 GROUP BY ((1509466140000, 1509466380000], 3m, 5ms) |
| Eg. SELECT MIN_TIME(status), MIN_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE temperature < 25 GROUP BY ((1509466140000, 1509466380000], 1mo) |
| Eg. SELECT MIN_TIME(status), MIN_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE temperature < 25 GROUP BY ((1509466140000, 1509466380000], 1mo, 1mo) |
| Eg. SELECT MIN_TIME(status), MIN_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE temperature < 25 GROUP BY ((1509466140000, 1509466380000], 1mo, 2mo) |
| Note: the statement needs to satisfy this constraint: <Path>(SelectClause) + <PrefixPath>(FromClause) = <Timeseries> |
| Note: If the <SensorExpr>(WhereClause) is started with <Path> and not with ROOT, the statement needs to satisfy this constraint: <PrefixPath>(FromClause) + <Path>(SensorExpr) = <Timeseries> |
| Note: <TimeValue>(TimeInterval) needs to be greater than 0 |
| Note: First <TimeValue>(TimeInterval) in needs to be smaller than second <TimeValue>(TimeInterval) |
| Note: <TimeUnit> needs to be greater than 0 |
| Note: Third <TimeUnit> if set shouldn't be smaller than second <TimeUnit> |
| Note: If the second <DurationUnit> is "mo", the third <DurationUnit> need to be in month |
| Note: If the third <DurationUnit> is "mo", the second <DurationUnit> can be in any unit |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Fill Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT <SelectClause> FROM <FromClause> WHERE <WhereClause> FILL <FillClause> |
| SelectClause : <Path> [COMMA <Path>]* |
| FromClause : < PrefixPath > [COMMA < PrefixPath >]* |
| WhereClause : <WhereExpression> |
| WhereExpression : TIME EQUAL <TimeValue> |
| FillClause : LPAREN <TypeClause> [COMMA <TypeClause>]* RPAREN |
| TypeClause : <Int32Clause> | <Int64Clause> | <FloatClause> | <DoubleClause> | <BoolClause> | <TextClause> |
| Int32Clause: INT32 LBRACKET (<LinearClause> | <PreviousClause>) RBRACKET |
| Int64Clause: INT64 LBRACKET (<LinearClause> | <PreviousClause>) RBRACKET |
| FloatClause: FLOAT LBRACKET (<LinearClause> | <PreviousClause>) RBRACKET |
| DoubleClause: DOUBLE LBRACKET (<LinearClause> | <PreviousClause>) RBRACKET |
| BoolClause: BOOLEAN LBRACKET (<LinearClause> | <PreviousClause>) RBRACKET |
| TextClause: TEXT LBRACKET (<LinearClause> | <PreviousClause>) RBRACKET |
| PreviousClause : PREVIOUS [COMMA <ValidPreviousTime>]? |
| LinearClause : LINEAR [COMMA <ValidPreviousTime> COMMA <ValidBehindTime>]? |
| ValidPreviousTime, ValidBehindTime: <TimeUnit> |
| TimeUnit : Integer <DurationUnit> |
| DurationUnit : "ms" | "s" | "m" | "h" | "d" | "w" |
| Eg: SELECT temperature FROM root.ln.wf01.wt01 WHERE time = 2017-11-01T16:37:50.000 FILL(float[previous, 1m]) |
| Eg: SELECT temperature,status FROM root.ln.wf01.wt01 WHERE time = 2017-11-01T16:37:50.000 FILL (float[linear, 1m, 1m], boolean[previous, 1m]) |
| Eg: SELECT temperature,status,hardware FROM root.ln.wf01.wt01 WHERE time = 2017-11-01T16:37:50.000 FILL (float[linear, 1m, 1m], boolean[previous, 1m], text[previous]) |
| Eg: SELECT temperature,status,hardware FROM root.ln.wf01.wt01 WHERE time = 2017-11-01T16:37:50.000 FILL (float[linear], boolean[previous, 1m], text[previous]) |
| Note: the statement needs to satisfy this constraint: <PrefixPath>(FromClause) + <Path>(SelectClause) = <Timeseries> |
| Note: Integer in <TimeUnit> needs to be greater than 0 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Group By Fill Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT <SelectClause> FROM <FromClause> WHERE <WhereClause> GROUP BY <GroupByClause> (FILL <GROUPBYFillClause>)? |
| GroupByClause : LPAREN <TimeInterval> COMMA <TimeUnit> RPAREN |
| GROUPBYFillClause : LPAREN <TypeClause> RPAREN |
| TypeClause : <AllClause> | <Int32Clause> | <Int64Clause> | <FloatClause> | <DoubleClause> | <BoolClause> | <TextClause> |
| AllClause: ALL LBRACKET (<PreviousUntilLastClause> | <PreviousClause>) RBRACKET |
| Int32Clause: INT32 LBRACKET (<PreviousUntilLastClause> | <PreviousClause>) RBRACKET |
| Int64Clause: INT64 LBRACKET (<PreviousUntilLastClause> | <PreviousClause>) RBRACKET |
| FloatClause: FLOAT LBRACKET (<PreviousUntilLastClause> | <PreviousClause>) RBRACKET |
| DoubleClause: DOUBLE LBRACKET (<PreviousUntilLastClause> | <PreviousClause>) RBRACKET |
| BoolClause: BOOLEAN LBRACKET (<PreviousUntilLastClause> | <PreviousClause>) RBRACKET |
| TextClause: TEXT LBRACKET (<PreviousUntilLastClause> | <PreviousClause>) RBRACKET |
| PreviousClause : PREVIOUS |
| PreviousUntilLastClause : PREVIOUSUNTILLAST |
| Eg: SELECT last_value(temperature) FROM root.ln.wf01.wt01 GROUP BY([20, 100), 5m) FILL (float[PREVIOUS]) |
| Eg: SELECT last_value(temperature) FROM root.ln.wf01.wt01 GROUP BY((15, 100], 5m) FILL (float[PREVIOUS]) |
| Eg: SELECT last_value(power) FROM root.ln.wf01.wt01 GROUP BY([20, 100), 5m) FILL (int32[PREVIOUSUNTILLAST]) |
| Eg: SELECT last_value(power) FROM root.ln.wf01.wt01 GROUP BY([20, 100), 5m) FILL (int32[PREVIOUSUNTILLAST, 5m]) |
| Eg: SELECT last_value(temperature), last_value(power) FROM root.ln.wf01.wt01 GROUP BY([20, 100), 5m) FILL (ALL[PREVIOUS]) |
| Eg: SELECT last_value(temperature), last_value(power) FROM root.ln.wf01.wt01 GROUP BY([20, 100), 5m) FILL (ALL[PREVIOUS, 5m]) |
| Note: In group by fill, sliding step is not supported in group by clause |
| Note: Now, only last_value aggregation function is supported in group by fill. |
| Note: Linear fill is not supported in group by fill. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Order by time Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT <SelectClause> FROM <FromClause> WHERE <WhereClause> GROUP BY <GroupByClause> (FILL <GROUPBYFillClause>)? orderByTimeClause? |
| orderByTimeClause: order by time (asc | desc)? |
| |
| Eg: SELECT last_value(temperature) FROM root.ln.wf01.wt01 GROUP BY([20, 100), 5m) FILL (float[PREVIOUS]) order by time desc |
| Eg: SELECT * from root.** order by time desc |
| Eg: SELECT * from root.** order by time desc align by device |
| Eg: SELECT * from root.** order by time desc disable align |
| Eg: SELECT last * from root.** order by time desc |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Limit Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT <SelectClause> FROM <FromClause> [WHERE <WhereClause>] [<LIMITClause>] [<SLIMITClause>] |
| SelectClause : [<Path> | Function]+ |
| Function : <AggregationFunction> LPAREN <Path> RPAREN |
| FromClause : <Path> |
| WhereClause : <Condition> [(AND | OR) <Condition>]* |
| Condition : <Expression> [(AND | OR) <Expression>]* |
| Expression: [NOT|!]?<TimeExpr> | [NOT|!]?<SensorExpr> |
| TimeExpr : TIME PrecedenceEqualOperator (<TimeValue> | <RelativeTime>) |
| RelativeTimeDurationUnit = Integer ('Y'|'MO'|'W'|'D'|'H'|'M'|'S'|'MS'|'US'|'NS') |
| RelativeTime : (now() | <TimeValue>) [(+|-) RelativeTimeDurationUnit]+ |
| SensorExpr : (<Timeseries>|<Path>) PrecedenceEqualOperator <PointValue> |
| LIMITClause : LIMIT <N> [OFFSETClause]? |
| N : Integer |
| OFFSETClause : OFFSET <OFFSETValue> |
| OFFSETValue : Integer |
| SLIMITClause : SLIMIT <SN> [SOFFSETClause]? |
| SN : Integer |
| SOFFSETClause : SOFFSET <SOFFSETValue> |
| SOFFSETValue : Integer |
| Eg: IoTDB > SELECT status, temperature FROM root.ln.wf01.wt01 WHERE temperature < 24 and time > 2017-11-1 0:13:00 LIMIT 3 OFFSET 2 |
| Eg. IoTDB > SELECT COUNT (status), MAX_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE time < 1509466500000 GROUP BY([1509465720000, 1509466380000], 5m) LIMIT 3 |
| Note: N, OFFSETValue, SN and SOFFSETValue must be greater than 0. |
| Note: The order of <LIMITClause> and <SLIMITClause> does not affect the grammatical correctness. |
| Note: <FillClause> can not use <LIMITClause> but not <SLIMITClause>. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Align By Device Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>AlignbyDeviceClause : ALIGN BY DEVICE |
| |
| Rules: |
| 1. Both uppercase and lowercase are ok. |
| Correct example: select * from root.sg1.* align by device |
| Correct example: select * from root.sg1.* ALIGN BY DEVICE |
| |
| 2. AlignbyDeviceClause can only be used at the end of a query statement. |
| Correct example: select * from root.sg1.* where time > 10 align by device |
| Wrong example: select * from root.sg1.* align by device where time > 10 |
| |
| 3. The paths of the SELECT clause can only be single level. In other words, the paths of the SELECT clause can only be measurements or STAR, without DOT. |
| Correct example: select s0,s1 from root.sg1.* align by device |
| Correct example: select s0,s1 from root.sg1.d0, root.sg1.d1 align by device |
| Correct example: select * from root.sg1.* align by device |
| Correct example: select * from root.** align by device |
| Correct example: select s0,s1,* from root.*.* align by device |
| Wrong example: select d0.s1, d0.s2, d1.s0 from root.sg1 align by device |
| Wrong example: select *.s0, *.s1 from root.* align by device |
| Wrong example: select *.*.* from root align by device |
| |
| 4. The data types of the same measurement column should be the same across devices. |
| Note that when it comes to aggregated paths, the data type of the measurement column will reflect |
| the aggregation function rather than the original timeseries. |
| |
| Correct example: select s0 from root.sg1.d0,root.sg1.d1 align by device |
| root.sg1.d0.s0 and root.sg1.d1.s0 are both INT32. |
| |
| Correct example: select count(s0) from root.sg1.d0,root.sg1.d1 align by device |
| count(root.sg1.d0.s0) and count(root.sg1.d1.s0) are both INT64. |
| |
| Wrong example: select s0 from root.sg1.d0, root.sg2.d3 align by device |
| root.sg1.d0.s0 is INT32 while root.sg2.d3.s0 is FLOAT. |
| |
| 5. The display principle of the result table is that all the columns (no matther whther a column has has existing data) will be shown, with nonexistent cells being null. Besides, the select clause support const column (e.g., 'a', '123' etc..). |
| For example, "select s0,s1,s2,'abc',s1,s2 from root.sg.d0, root.sg.d1, root.sg.d2 align by device". Suppose that the actual existing timeseries are as follows: |
| - root.sg.d0.s0 |
| - root.sg.d0.s1 |
| - root.sg.d1.s0 |
| |
| Then you could expect a table like: |
| |
| | Time | Device | s0 | s1 | s2 | 'abc' | s1 | s2 | |
| | --- | --- | ---| ---| null | 'abc' | ---| null | |
| | 1 |root.sg.d0| 20 | 2.5| null | 'abc' | 2.5| null | |
| | 2 |root.sg.d0| 23 | 3.1| null | 'abc' | 3.1| null | |
| | ... | ... | ...| ...| null | 'abc' | ...| null | |
| | 1 |root.sg.d1| 12 |null| null | 'abc' |null| null | |
| | 2 |root.sg.d1| 19 |null| null | 'abc' |null| null | |
| | ... | ... | ...| ...| null | 'abc' | ...| null | |
| |
| Note that the cells of measurement 's0' and device 'root.sg.d1' are all null. |
| |
| 6. The duplicated devices in the prefix paths are neglected. |
| For example, "select s0,s1 from root.sg.d0,root.sg.d0,root.sg.d1 align by device" is equal to "select s0,s1 from root.sg.d0,root.sg.d1 align by device". |
| For example. "select s0,s1 from root.sg.*,root.sg.d0 align by device" is equal to "select s0,s1 from root.sg.* align by device". |
| |
| 7. The duplicated measurements in the suffix paths are not neglected. |
| For example, "select s0,s0,s1 from root.sg.* align by device" is not equal to "select s0,s1 from root.sg.* align by device". |
| |
| 8. Both time predicates and value predicates are allowed in Where Clause. The paths of the value predicates can be the leaf node or full path started with ROOT. And wildcard is not allowed here. For example: |
| - select * from root.sg.* where time = 1 align by device |
| - select * from root.sg.* where s0 < 100 align by device |
| - select * from root.sg.* where time < 20 AND s0 > 50 align by device |
| - select * from root.sg.d0 where root.sg.d0.s0 = 15 align by device |
| |
| 9. More correct examples: |
| - select * from root.vehicle.* align by device |
| - select s0,s0,s1 from root.vehicle.* align by device |
| - select s0,s1 from root.vehicle.* limit 10 offset 1 align by device |
| - select * from root.vehicle.* slimit 10 soffset 2 align by device |
| - select * from root.vehicle.* where time > 10 align by device |
| - select * from root.vehicle.* where time < 10 AND s0 > 25 align by device |
| - select * from root.vehicle.* where root.vehicle.d0.s0>0 align by device |
| - select count(*) from root.vehicle align by device |
| - select sum(*) from root.vehicle.* GROUP BY (20ms,0,[2,50]) align by device |
| - select * from root.vehicle.* where time = 3 Fill(int32[previous, 5ms]) align by device |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Disable Align Statement</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>Disable Align Clause: DISABLE ALIGN |
| |
| Rules: |
| 1. Both uppercase and lowercase are ok. |
| Correct example: select * from root.sg1.* disable align |
| Correct example: select * from root.sg1.* DISABLE ALIGN |
| |
| 2. Disable Align Clause can only be used at the end of a query statement. |
| Correct example: select * from root.sg1.* where time > 10 disable align |
| Wrong example: select * from root.sg1.* disable align where time > 10 |
| |
| 3. Disable Align Clause cannot be used with Aggregation, Fill Statements, Group By or Group By Device Statements, but can with Limit Statements. |
| Correct example: select * from root.sg1.* limit 3 offset 2 disable align |
| Correct example: select * from root.sg1.* slimit 3 soffset 2 disable align |
| Wrong example: select count(s0),count(s1) from root.sg1.d1 disable align |
| Wrong example: select * from root.vehicle.* where root.vehicle.d0.s0>0 disable align |
| Wrong example: select * from root.vehicle.* align by device disable align |
| |
| 4. The display principle of the result table is that only when the column (or row) has existing data will the column (or row) be shown, with nonexistent cells being empty. |
| |
| You could expect a table like: |
| | Time | root.sg.d0.s1 | Time | root.sg.d0.s2 | Time | root.sg.d1.s1 | |
| | --- | --- | --- | --- | --- | --- | |
| | 1 | 100 | 20 | 300 | 400 | 600 | |
| | 2 | 300 | 40 | 800 | 700 | 900 | |
| | 4 | 500 | | | 800 | 1000 | |
| | | | | | 900 | 8000 | |
| |
| 5. More correct examples: |
| - select * from root.vehicle.* disable align |
| - select s0,s0,s1 from root.vehicle.* disable align |
| - select s0,s1 from root.vehicle.* limit 10 offset 1 disable align |
| - select * from root.vehicle.* slimit 10 soffset 2 disable align |
| - select * from root.vehicle.* where time > 10 disable align |
| |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Select Last Record Statement</li></ul><p>The LAST function returns the last time-value pair of the given timeseries. Currently filters are not supported in LAST queries.</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT LAST <SelectClause> FROM <FromClause> |
| Select Clause : <Path> [COMMA <Path>]* |
| FromClause : < PrefixPath > [COMMA < PrefixPath >]* |
| WhereClause : <TimeExpr> [(AND | OR) <TimeExpr>]* |
| TimeExpr : TIME PrecedenceEqualOperator (<TimeValue> | <RelativeTime>) |
| |
| Eg. SELECT LAST s1 FROM root.sg.d1 |
| Eg. SELECT LAST s1, s2 FROM root.sg.d1 |
| Eg. SELECT LAST s1 FROM root.sg.d1, root.sg.d2 |
| Eg. SELECT LAST s1 FROM root.sg.d1 where time > 100 |
| Eg. SELECT LAST s1, s2 FROM root.sg.d1 where time >= 500 |
| |
| Rules: |
| 1. the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| |
| 2. SELECT LAST only supports time filter that contains '>' or '>=' currently. |
| |
| 3. The result set of last query will always be displayed in a fixed three column table format. |
| For example, "select last s1, s2 from root.sg.d1, root.sg.d2", the query result would be: |
| |
| | Time | Path | Value | dataType | |
| | --- | ------------- |------ | -------- | |
| | 5 | root.sg.d1.s1 | 100 | INT32 | |
| | 2 | root.sg.d1.s2 | 400 | INT32 | |
| | 4 | root.sg.d2.s1 | 250 | INT32 | |
| | 9 | root.sg.d2.s2 | 600 | INT32 | |
| |
| 4. It is not supported to use "diable align" in LAST query. |
| |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>As Statement</li></ul><p>As statement assigns an alias to time seires queried in SELECT statement</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>You can use as statement in all queries, but some rules are restricted about wildcard. |
| |
| 1. Raw data query |
| select s1 as speed, s2 as temperature from root.sg.d1 |
| |
| The result set will be like： |
| | Time | speed | temperature | |
| | ... | ... | .... | |
| |
| 2. Aggregation query |
| select count(s1) as s1_num, max_value(s2) as s2_max from root.sg.d1 |
| |
| 3. Down-frequence query |
| select count(s1) as s1_num from root.sg.d1 group by ([100,500), 80ms) |
| |
| 4. Align by device query |
| select s1 as speed, s2 as temperature from root.sg.d1 align by device |
| |
| select count(s1) as s1_num, count(s2), count(s3) as s3_num from root.sg.d2 align by device |
| |
| 5. Last Record query |
| select last s1 as speed, s2 from root.sg.d1 |
| |
| Rules： |
| 1. In addition to Align by device query，each AS statement has to corresponding to one time series exactly. |
| |
| E.g. select s1 as temperature from root.sg.* |
| |
| At this time if \`root.sg.*\` includes more than one device，then an exception will be thrown。 |
| |
| 2. In align by device query，the prefix path that each AS statement corresponding to can includes multiple device, but the suffix path can only be single sensor. |
| |
| E.g. select s1 as temperature from root.sg.* |
| |
| In this situation, it will be show correctly even if multiple devices are selected. |
| |
| E.g. select * as temperature from root.sg.d1 |
| |
| In this situation, it will throws an exception if * corresponds to multiple sensors. |
| |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Regexp Statement</li></ul><p>Regexp Statement only supports regular expressions with Java standard library style on timeseries which is TEXT data type</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT <SelectClause> FROM <FromClause> WHERE <WhereClause> |
| Select Clause : <Path> [COMMA <Path>]* |
| FromClause : < PrefixPath > [COMMA < PrefixPath >]* |
| WhereClause : andExpression (OPERATOR_OR andExpression)* |
| andExpression : predicate (OPERATOR_AND predicate)* |
| predicate : (suffixPath | fullPath) REGEXP regularExpression |
| regularExpression: Java standard regularexpression, like '^[a-z][0-9]$', [details](https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html) |
| |
| Eg. select s1 from root.sg.d1 where s1 regexp '^[0-9]*$' |
| Eg. select s1, s2 FROM root.sg.d1 where s1 regexp '^\\w+([-+.]\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*$' and s2 regexp '^\\d{15}|\\d{18}$' |
| Eg. select * from root.sg.d1 where s1 regexp '^[a-zA-Z]\\w{5,17}$' |
| Eg. select * from root.sg.d1 where s1 regexp '^\\d{4}-\\d{1,2}-\\d{1,2}' and time > 100 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Like Statement</li></ul><p>The usage of LIKE Statement similar with mysql, but only support timeseries which is TEXT data type</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT <SelectClause> FROM <FromClause> WHERE <WhereClause> |
| Select Clause : <Path> [COMMA <Path>]* |
| FromClause : < PrefixPath > [COMMA < PrefixPath >]* |
| WhereClause : andExpression (OPERATOR_OR andExpression)* |
| andExpression : predicate (OPERATOR_AND predicate)* |
| predicate : (suffixPath | fullPath) LIKE likeExpression |
| likeExpression : string that may contains "%" or "_", while "%value" means a string that ends with the value, "value%" means a string starts with the value, "%value%" means string that contains values, and "_" represents any character. |
| |
| Eg. select s1 from root.sg.d1 where s1 like 'abc' |
| Eg. select s1, s2 from root.sg.d1 where s1 like 'a%bc' |
| Eg. select * from root.sg.d1 where s1 like 'abc_' |
| Eg. select * from root.sg.d1 where s1 like 'abc\\%' and time > 100 |
| In this situation, '\\%' means '%' will be escaped |
| The result set will be like: |
| | Time | Path | Value | |
| | --- | ------------ | ----- | |
| | 200 | root.sg.d1.s1| abc% | |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="database-management-statement" tabindex="-1"><a class="header-anchor" href="#database-management-statement" aria-hidden="true">#</a> Database Management Statement</h2><ul><li>Create User</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>CREATE USER <userName> <password>; |
| userName:=identifier |
| password:=string |
| Eg: IoTDB > CREATE USER thulab 'pwd'; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Delete User</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>DROP USER <userName>; |
| userName:=identifier |
| Eg: IoTDB > DROP USER xiaoming; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Create Role</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>CREATE ROLE <roleName>; |
| roleName:=identifie |
| Eg: IoTDB > CREATE ROLE admin; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Delete Role</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>DROP ROLE <roleName>; |
| roleName:=identifier |
| Eg: IoTDB > DROP ROLE admin; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Grant User Privileges</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>GRANT USER <userName> PRIVILEGES <privileges> ON <nodeName>; |
| userName:=identifier |
| nodeName:=identifier (DOT identifier)* |
| privileges:= string (COMMA string)* |
| Eg: IoTDB > GRANT USER tempuser PRIVILEGES DELETE_TIMESERIES on root.ln; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Grant Role Privileges</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>GRANT ROLE <roleName> PRIVILEGES <privileges> ON <nodeName>; |
| privileges:= string (COMMA string)* |
| roleName:=identifier |
| nodeName:=identifier (DOT identifier)* |
| Eg: IoTDB > GRANT ROLE temprole PRIVILEGES DELETE_TIMESERIES ON root.ln; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Grant User Role</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>GRANT <roleName> TO <userName>; |
| roleName:=identifier |
| userName:=identifier |
| Eg: IoTDB > GRANT temprole TO tempuser; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Revoke User Privileges</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>REVOKE USER <userName> PRIVILEGES <privileges> ON <nodeName>; |
| privileges:= string (COMMA string)* |
| userName:=identifier |
| nodeName:=identifier (DOT identifier)* |
| Eg: IoTDB > REVOKE USER tempuser PRIVILEGES DELETE_TIMESERIES on root.ln; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Revoke Role Privileges</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>REVOKE ROLE <roleName> PRIVILEGES <privileges> ON <nodeName>; |
| privileges:= string (COMMA string)* |
| roleName:= identifier |
| nodeName:=identifier (DOT identifier)* |
| Eg: IoTDB > REVOKE ROLE temprole PRIVILEGES DELETE_TIMESERIES ON root.ln; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Revoke Role From User</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>REVOKE <roleName> FROM <userName>; |
| roleName:=identifier |
| userName:=identifier |
| Eg: IoTDB > REVOKE temprole FROM tempuser; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>List Users</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>LIST USER |
| Eg: IoTDB > LIST USER |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>List Roles</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>LIST ROLE |
| Eg: IoTDB > LIST ROLE |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>List Privileges</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>LIST PRIVILEGES USER <username> ON <path>; |
| username:=identifier |
| path=‘root’ (DOT identifier)* |
| Eg: IoTDB > LIST PRIVILEGES USER sgcc_wirte_user ON root.sgcc; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>List Privileges of Roles</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>LIST ROLE PRIVILEGES <roleName> |
| roleName:=identifier |
| Eg: IoTDB > LIST ROLE PRIVILEGES actor; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>List Privileges of Roles(On Specific Path)</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>LIST PRIVILEGES ROLE <roleName> ON <path>; |
| roleName:=identifier |
| path=‘root’ (DOT identifier)* |
| Eg: IoTDB > LIST PRIVILEGES ROLE wirte_role ON root.sgcc; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>List Privileges of Users</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>LIST USER PRIVILEGES <username> ; |
| username:=identifier |
| Eg: IoTDB > LIST USER PRIVILEGES tempuser; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>List Roles of Users</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>LIST ALL ROLE OF USER <username> ; |
| username:=identifier |
| Eg: IoTDB > LIST ALL ROLE OF USER tempuser; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>List Users of Role</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>LIST ALL USER OF ROLE <roleName>; |
| roleName:=identifier |
| Eg: IoTDB > LIST ALL USER OF ROLE roleuser; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Alter Password</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>ALTER USER <username> SET PASSWORD <password>; |
| roleName:=identifier |
| password:=identifier |
| Eg: IoTDB > ALTER USER tempuser SET PASSWORD 'newpwd'; |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="functions" tabindex="-1"><a class="header-anchor" href="#functions" aria-hidden="true">#</a> Functions</h2><ul><li>COUNT</li></ul><p>The COUNT function returns the value number of timeseries(one or more) non-null values selected by the SELECT statement. The result is a signed 64-bit integer. If there are no matching rows, COUNT () returns 0.</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT COUNT(Path) (COMMA COUNT(Path))* FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT COUNT(status), COUNT(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>FIRST_VALUE(Rename from <code>FIRST</code> at <code>V0.10.0</code>)</li></ul><p>The FIRST_VALUE function returns the first point value of the choosen timeseries(one or more).</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT FIRST_VALUE (Path) (COMMA FIRST_VALUE (Path))* FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT FIRST_VALUE (status), FIRST_VALUE (temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>LAST_VALUE</li></ul><p>The LAST_VALUE function returns the last point value of the choosen timeseries(one or more).</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT LAST_VALUE (Path) (COMMA LAST_VALUE (Path))* FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT LAST_VALUE (status), LAST_VALUE (temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>MAX_TIME</li></ul><p>The MAX_TIME function returns the maximum timestamp of the choosen timeseries(one or more). The result is a signed 64-bit integer, greater than 0.</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT MAX_TIME (Path) (COMMA MAX_TIME (Path))* FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT MAX_TIME(status), MAX_TIME(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>MAX_VALUE</li></ul><p>The MAX_VALUE function returns the maximum value(lexicographically ordered) of the choosen timeseries (one or more).</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT MAX_VALUE (Path) (COMMA MAX_VALUE (Path))* FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT MAX_VALUE(status), MAX_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>EXTREME</li></ul><p>The EXTREME function returns the extreme value(lexicographically ordered) of the choosen timeseries (one or more). extreme value: The value that has the maximum absolute value. If the maximum absolute value of a positive value and a negative value is equal, return the positive value.</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT EXTREME (Path) (COMMA EXT (Path))* FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT EXTREME(status), EXTREME(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>AVG(Rename from <code>MEAN</code> at <code>V0.9.0</code>)</li></ul><p>The AVG function returns the arithmetic mean value of the choosen timeseries over a specified period of time. The timeseries must be int32, int64, float, double type, and the other types are not to be calculated. The result is a double type number.</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT AVG (Path) (COMMA AVG (Path))* FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT AVG (temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>MIN_TIME</li></ul><p>The MIN_TIME function returns the minimum timestamp of the choosen timeseries(one or more). The result is a signed 64-bit integer, greater than 0.</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT MIN_TIME (Path) (COMMA MIN_TIME (Path))*FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT MIN_TIME(status), MIN_TIME(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>MIN_VALUE</li></ul><p>The MIN_VALUE function returns the minimum value(lexicographically ordered) of the choosen timeseries (one or more).</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT MIN_VALUE (Path) (COMMA MIN_VALUE (Path))* FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT MIN_VALUE(status),MIN_VALUE(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>NOW</li></ul><p>The NOW function returns the current timestamp. This function can be used in the data operation statement to represent time. The result is a signed 64-bit integer, greater than 0.</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>NOW() |
| Eg. INSERT INTO root.ln.wf01.wt01(timestamp,status) VALUES(NOW(), false) |
| Eg. DELETE FROM root.ln.wf01.wt01.status, root.ln.wf01.wt01.temperature WHERE time < NOW() |
| Eg. SELECT * FROM root.** WHERE time < NOW() |
| Eg. SELECT COUNT(temperature) FROM root.ln.wf01.wt01 WHERE time < NOW() |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>SUM</li></ul><p>The SUM function returns the sum of the choosen timeseries (one or more) over a specified period of time. The timeseries must be int32, int64, float, double type, and the other types are not to be calculated. The result is a double type number.</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SELECT SUM(Path) (COMMA SUM(Path))* FROM <FromClause> [WHERE <WhereClause>]? |
| Eg. SELECT SUM(temperature) FROM root.ln.wf01.wt01 WHERE root.ln.wf01.wt01.temperature < 24 |
| Note: the statement needs to satisfy this constraint: <PrefixPath> + <Path> = <Timeseries> |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="ttl" tabindex="-1"><a class="header-anchor" href="#ttl" aria-hidden="true">#</a> TTL</h2><p>IoTDB supports storage-level TTL settings, which means it is able to delete old data automatically and periodically. The benefit of using TTL is that hopefully you can control the total disk space usage and prevent the machine from running out of disks. Moreover, the query performance may downgrade as the total number of files goes up and the memory usage also increase as there are more files. Timely removing such files helps to keep at a high query performance level and reduce memory usage. The TTL operations in IoTDB are supported by the following three statements:</p><ul><li>Set TTL</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SET TTL TO StorageGroupName TTLTime |
| Eg. SET TTL TO root.group1 3600000 |
| This example means that for data in root.group1, only that of the latest 1 hour will remain, the |
| older one is removed or made invisible. |
| Note: TTLTime should be millisecond timestamp. When TTL is set, insertions that fall |
| out of TTL will be rejected. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Unset TTL</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>UNSET TTL TO StorageGroupName |
| Eg. UNSET TTL TO root.group1 |
| This example means that data of all time will be accepted in this group. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>Show TTL</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW ALL TTL |
| SHOW TTL ON StorageGroupNames |
| Eg.1 SHOW ALL TTL |
| This example will show TTLs of all databases. |
| Eg.2 SHOW TTL ON root.group1,root.group2,root.group3 |
| This example will show TTLs of the specified 3 groups. |
| Notice: databases without TTL will show a "null" |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Notice: When you set TTL to some databases, data out of the TTL will be made invisible immediately, but because the data files may contain both out-dated and living data or the data files may be being used by queries, the physical removal of data is stale. If you increase or unset TTL just after setting it previously, some previously invisible data may be seen again, but the physically removed one is lost forever. In other words, different from delete statement, the atomicity of data deletion is not guaranteed for efficiency concerns. So we recommend that you do not change the TTL once it is set or at least do not reset it frequently, unless you are determined to suffer the unpredictability.</p><ul><li>Delete Partition (experimental)</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>DELETE PARTITION StorageGroupName INT(COMMA INT)* |
| Eg DELETE PARTITION root.sg1 0,1,2 |
| This example will delete the first 3 time partitions of database root.sg1. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>The partitionId can be found in data folders or converted using <code>timestamp / partitionInterval</code>.</p><h2 id="kill-query" tabindex="-1"><a class="header-anchor" href="#kill-query" aria-hidden="true">#</a> Kill query</h2><ul><li>Show the list of queries in progress</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>SHOW QUERY PROCESSLIST |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><ul><li>Kill query</li></ul><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>KILL QUERY INT? |
| E.g. KILL QUERY |
| E.g. KILL QUERY 2 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="set-ststem-to-readonly-writable" tabindex="-1"><a class="header-anchor" href="#set-ststem-to-readonly-writable" aria-hidden="true">#</a> SET STSTEM TO READONLY / WRITABLE</h2><p>Set IoTDB system to read-only or writable mode.</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>IoTDB> SET SYSTEM TO READONLY |
| IoTDB> SET SYSTEM TO WRITABLE |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="identifiers" tabindex="-1"><a class="header-anchor" href="#identifiers" aria-hidden="true">#</a> Identifiers</h2><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>QUOTE := '\\''; |
| DOT := '.'; |
| COLON : ':' ; |
| COMMA := ',' ; |
| SEMICOLON := ';' ; |
| LPAREN := '(' ; |
| RPAREN := ')' ; |
| LBRACKET := '['; |
| RBRACKET := ']'; |
| EQUAL := '=' | '=='; |
| NOTEQUAL := '<>' | '!='; |
| LESSTHANOREQUALTO := '<='; |
| LESSTHAN := '<'; |
| GREATERTHANOREQUALTO := '>='; |
| GREATERTHAN := '>'; |
| DIVIDE := '/'; |
| PLUS := '+'; |
| MINUS := '-'; |
| STAR := '*'; |
| Letter := 'a'..'z' | 'A'..'Z'; |
| HexDigit := 'a'..'f' | 'A'..'F'; |
| Digit := '0'..'9'; |
| Boolean := TRUE | FALSE | 0 | 1 (case insensitive) |
| |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>StringLiteral := ( '\\'' ( ~('\\'') )* '\\''; |
| eg. 'abc' |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>Integer := ('-' | '+')? Digit+; |
| eg. 123 |
| eg. -222 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>Float := ('-' | '+')? Digit+ DOT Digit+ (('e' | 'E') ('-' | '+')? Digit+)?; |
| eg. 3.1415 |
| eg. 1.2E10 |
| eg. -1.33 |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>Identifier := (Letter | '_') (Letter | Digit | '_' | MINUS)*; |
| eg. a123 |
| eg. _abc123 |
| |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="literals" tabindex="-1"><a class="header-anchor" href="#literals" aria-hidden="true">#</a> Literals</h2><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>PointValue : Integer | Float | StringLiteral | Boolean |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>TimeValue : Integer | DateTime | ISO8601 | NOW() |
| Note: Integer means timestamp type. |
| |
| DateTime : |
| eg. 2016-11-16T16:22:33+08:00 |
| eg. 2016-11-16 16:22:33+08:00 |
| eg. 2016-11-16T16:22:33.000+08:00 |
| eg. 2016-11-16 16:22:33.000+08:00 |
| Note: DateTime Type can support several types, see Chapter 3 Datetime section for details. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>PrecedenceEqualOperator : EQUAL | NOTEQUAL | LESSTHANOREQUALTO | LESSTHAN | GREATERTHANOREQUALTO | GREATERTHAN |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>Timeseries : ROOT [DOT \\<LayerName\\>]* DOT \\<SensorName\\> |
| LayerName : Identifier |
| SensorName : Identifier |
| eg. root.ln.wf01.wt01.status |
| eg. root.sgcc.wf03.wt01.temperature |
| Note: Timeseries must be start with \`root\`(case insensitive) and end with sensor name. |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>PrefixPath : ROOT (DOT \\<LayerName\\>)* |
| LayerName : Identifier | STAR |
| eg. root.sgcc |
| eg. root.* |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>Path: (ROOT | <LayerName>) (DOT <LayerName>)* |
| LayerName: Identifier | STAR |
| eg. root.ln.wf01.wt01.status |
| eg. root.*.wf01.wt01.status |
| eg. root.ln.wf01.wt01.* |
| eg. *.wt01.* |
| eg. * |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div>`,196);function r(d,u){return i(),t("div",null,[n(` |
| |
| 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. |
| |
| `),a])}const v=e(s,[["render",r],["__file","SQL-Reference.html.vue"]]);export{v as default}; |
