@transitive-sdk/clickhouse 0.3.5 → 0.3.7

package/index.js

@@ -8,7 +8,7 @@ const { topicToPath, topicMatch } = require('@transitive-sdk/datacache');
 // Default TTL in days for mqtt_history table
 const DEFAULT_TTL_DAYS = 30;
 
-// Shared multi-tenant schema components used by createTable and ensureMqttHistoryTable
+// Shared multi-tenant schema components used by createTable and enableHistory
 const MULTI_TENANT_SCHEMA = {
   // Column definitions for OrgId and DeviceId
   columns: [
@@ -54,7 +54,7 @@ class ClickHouse {
 
     const {hostname, port} = URL.parse(_url);
     const interval = 200;
-    await waitPort({ host: hostname, port: port || 80, interval }, 10000);
+    await waitPort({ host: hostname, port: Number(port || 80), interval }, 10000);
     await new Promise(done => setTimeout(done, 200));
 
     // console.debug(`Creating ClickHouse client for URL: ${_url}, DB: ${_dbName}, User: ${_user}`);
@@ -109,13 +109,15 @@ class ClickHouse {
    * @param {Array<string>} columns - array of column definitions and indexes, e.g. ['Timestamp DateTime CODEC(ZSTD(1))', 'Value Float32 CODEC(ZSTD(1))']
    * @param {Array<string>} settings - array of table settings, e.g. ['ENGINE = MergeTree()', 'ORDER BY (Timestamp)']
    */
-  async createTable(tableName, columns, settings = []) {
+  async createTable(tableName, columns, settings = ['ORDER BY (OrgId, DeviceId)']) {
     const fullSchema = [
       ...columns,
       ...MULTI_TENANT_SCHEMA.columns,
       ...MULTI_TENANT_SCHEMA.indexes
     ];
-    const query = `CREATE TABLE IF NOT EXISTS ${tableName} (${fullSchema.join(', ')}) ${settings.join(' ')}`;
+    const query = `CREATE TABLE IF NOT EXISTS ${tableName}
+      (${fullSchema.join(', ')})
+      ${settings.join(' ')}`;
 
     try {
       return await this.client.exec({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transitive-sdk/clickhouse",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "description": "A tiny ClickHouse utility class for use in the Transitive framework.",
   "homepage": "https://transitiverobotics.com",
   "repository": {

package/test/clickhouse.test.js

@@ -67,6 +67,19 @@ describe('ClickHouse', function() {
     await clickhouse.registerMqttTopicForStorage(STANDARD_TOPIC_PATTERN);
   });
 
+  describe('basics', () => {
+    it('creates tables without crashing', async () => {
+      const result = await clickhouse.createTable('test_tmp',
+        ['text String']);
+
+      // clean up
+      await clickhouse.client.command({
+        query: `DROP TABLE IF EXISTS test_tmp`,
+        clickhouse_settings: { wait_end_of_query: 1 }
+      })
+    });
+  });
+
   describe('enableHistory', () => {
     it('should create the mqtt_history table', async () => {
       const result = await clickhouse.client.query({