Communication Service protocol

    IoTDB server and client use thrift for communication. In actual use, it is recommended to use the native client package provided by IoTDB: Session or Session Pool. If you have special needs, you can also program directly against the RPC interface

    to change the default thrift port

    2. TSOpenSessionResp openSession(1:TSOpenSessionReq req);
    4. // close a session
    5. TSStatus closeSession(1:TSCloseSessionReq req);
    7. // run an SQL statement in batch
    8. TSExecuteStatementResp executeStatement(1:TSExecuteStatementReq req);
    10. // execute SQL statement in batch
    11. TSStatus executeBatchStatement(1:TSExecuteBatchStatementReq req);
    13. // execute query SQL statement
    14. TSExecuteStatementResp executeQueryStatement(1:TSExecuteStatementReq req);
    16. // execute insert, delete and update SQL statement 
    17. TSExecuteStatementResp executeUpdateStatement(1:TSExecuteStatementReq req);
    19. // fetch next query result
    20. TSFetchResultsResp fetchResults(1:TSFetchResultsReq req)
    22. // fetch meta data
    23. TSFetchMetadataResp fetchMetadata(1:TSFetchMetadataReq req)
    25. // cancel a query 
    26. TSStatus cancelOperation(1:TSCancelOperationReq req);
    28. // close a query dataset
    29. TSStatus closeOperation(1:TSCloseOperationReq req);
    31. TSGetTimeZoneResp getTimeZone(1:i64 sessionId);
    33. // set time zone
    36. // get server's properties
    37. ServerProperties getProperties();
    39. // set storage group
    40. TSStatus setStorageGroup(1:i64 sessionId, 2:string storageGroup);
    42. // create timeseries
    43. TSStatus createTimeseries(1:TSCreateTimeseriesReq req);
    45. // create multi timeseries
    46. TSStatus createMultiTimeseries(1:TSCreateMultiTimeseriesReq req);
    48. // delete timeseries
    49. TSStatus deleteTimeseries(1:i64 sessionId, 2:list<string> path)
    51. // delete sttorage groups
    52. TSStatus deleteStorageGroups(1:i64 sessionId, 2:list<string> storageGroup);
    54. // insert record
    55. TSStatus insertRecord(1:TSInsertRecordReq req);
    57. // insert record in string format
    58. TSStatus insertStringRecord(1:TSInsertStringRecordReq req);
    60. // insert tablet
    61. TSStatus insertTablet(1:TSInsertTabletReq req);
    63. // insert tablets in batch
    64. TSStatus insertTablets(1:TSInsertTabletsReq req);
    66. TSStatus insertRecords(1:TSInsertRecordsReq req);
    68. // insert records of one device
    69. TSStatus insertRecordsOfOneDevice(1:TSInsertRecordsOfOneDeviceReq req);
    71. // insert records in batch as string format
    72. TSStatus insertStringRecords(1:TSInsertStringRecordsReq req);
    74. // test the latency of innsert tablet，caution：no data will be inserted, only for test latency
    75. TSStatus testInsertTablet(1:TSInsertTabletReq req);
    77. // test the latency of innsert tablets，caution：no data will be inserted, only for test latency
    78. TSStatus testInsertTablets(1:TSInsertTabletsReq req);
    80. // test the latency of innsert record，caution：no data will be inserted, only for test latency
    81. TSStatus testInsertRecord(1:TSInsertRecordReq req);
    83. // test the latency of innsert record in string format，caution：no data will be inserted, only for test latency
    84. TSStatus testInsertStringRecord(1:TSInsertStringRecordReq req);
    86. // test the latency of innsert records，caution：no data will be inserted, only for test latency
    87. TSStatus testInsertRecords(1:TSInsertRecordsReq req);
    89. // test the latency of innsert records of one device，caution：no data will be inserted, only for test latency
    90. TSStatus testInsertRecordsOfOneDevice(1:TSInsertRecordsOfOneDeviceReq req);
    92. // test the latency of innsert records in string formate，caution：no data will be inserted, only for test latency
    93. TSStatus testInsertStringRecords(1:TSInsertStringRecordsReq req);
    95. // delete data
    96. TSStatus deleteData(1:TSDeleteDataReq req);
    98. // execute raw data query
    99. TSExecuteStatementResp executeRawDataQuery(1:TSRawDataQueryReq req);
    101. i64 requestStatementId(1:i64 sessionId);

    We will use thrift compile IDL file in mvn Compilation, in which generate target .class file target file path is “thrift/target/classes/org/apache/iotdb/service/rpc/thrift”