@devrev/meerkat-node 0.0.96 → 0.0.98

package/README.md

@@ -1,11 +1,67 @@
-# meerkat-node
+# @devrev/meerkat-node
 
-This library was generated with [Nx](https://nx.dev).
+`@devrev/meerkat-node` is a library for converting cube queries into SQL and executing them in a Node.js environment using [DuckDB](https://duckdb.org/). It serves as a server-side query engine within the Meerkat ecosystem.
 
-## Building
+This package uses `@devrev/meerkat-core` to generate a DuckDB-compatible AST and `duckdb` to execute the resulting query against local data files like Parquet or CSV.
 
-Run `nx build meerkat-node` to build the library.
+## Key Features
 
-## Running unit tests
+- **Cube to SQL Execution**: Translates cube queries into SQL and executes them.
+- **Node.js Optimized**: Built to work seamlessly with `duckdb`.
+- **Simplified API**: Provides a `duckdbExec` utility for easy query execution.
 
-Run `nx test meerkat-node` to execute the unit tests via [Jest](https://jestjs.io).
+## Installation
+
+```bash
+npm install @devrev/meerkat-node @devrev/meerkat-core
+```
+
+## Basic Usage
+
+Here's a basic example of how to convert a cube query into SQL and execute it.
+
+```typescript
+import { cubeQueryToSQL, duckdbExec } from '@devrev/meerkat-node';
+import { Query, TableSchema } from '@devrev/meerkat-core';
+
+async function main() {
+  // 1. Define your table schema. In Node.js, the SQL typically points to a data file.
+  const tableSchema: TableSchema = {
+    name: 'users',
+    sql: `SELECT * FROM 'users.parquet'`,
+    columns: [
+      { name: 'id', type: 'INTEGER' },
+      { name: 'name', type: 'VARCHAR' },
+      { name: 'city', type: 'VARCHAR' },
+      { name: 'signed_up_at', type: 'TIMESTAMP' },
+    ],
+  };
+
+  // 2. Define your Cube query.
+  const query: Query = {
+    measures: ['users.count'],
+    dimensions: ['users.city'],
+    filters: [
+      {
+        member: 'users.city',
+        operator: 'equals',
+        values: ['New York'],
+      },
+    ],
+    limit: 100,
+  };
+
+  // 3. Convert the query to SQL.
+  const sql = await cubeQueryToSQL({
+    query,
+    tableSchemas: [tableSchema],
+  });
+
+  // 4. Execute the query using DuckDB.
+  const results = await duckdbExec(sql);
+
+  console.log('Query Results:', results);
+}
+
+main();
+```

package/index.js

@@ -1,17 +1,10 @@
 "use strict";
-Object.defineProperty(exports, "convertCubeStringToTableSchema", {
-    enumerable: true,
-    get: function() {
-        return _meerkatcore.convertCubeStringToTableSchema;
-    }
-});
 const _export_star = require("@swc/helpers/_/_export_star");
 _export_star._(require("./cube-to-sql-with-resolution/cube-to-sql-with-resolution"), exports);
 _export_star._(require("./cube-to-sql/cube-to-sql"), exports);
-_export_star._(require("./duckdb-singleton"), exports);
-_export_star._(require("./node-sql-to-serialization"), exports);
-const _meerkatcore = require("@devrev/meerkat-core");
 _export_star._(require("./duckdb-manager/duckdb-manager"), exports);
+_export_star._(require("./duckdb-singleton"), exports);
 _export_star._(require("./file-manager/file-manager"), exports);
+_export_star._(require("./node-sql-to-serialization"), exports);
 
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../meerkat-node/src/index.ts"],"sourcesContent":["export * from './cube-to-sql-with-resolution/cube-to-sql-with-resolution';\nexport * from './cube-to-sql/cube-to-sql';\nexport * from './duckdb-singleton';\nexport * from './node-sql-to-serialization';\nexport { convertCubeStringToTableSchema };\nimport { convertCubeStringToTableSchema } from '@devrev/meerkat-core';\nexport * from './duckdb-manager/duckdb-manager';\nexport * from './file-manager/file-manager';\n"],"names":["convertCubeStringToTableSchema"],"mappings":";+BAISA;;;eAAAA,2CAA8B;;;;uBAJzB;uBACA;uBACA;uBACA;6BAEiC;uBACjC;uBACA"}
+{"version":3,"sources":["../../meerkat-node/src/index.ts"],"sourcesContent":["export * from './cube-to-sql-with-resolution/cube-to-sql-with-resolution';\nexport * from './cube-to-sql/cube-to-sql';\nexport * from './duckdb-manager/duckdb-manager';\nexport * from './duckdb-singleton';\nexport * from './file-manager/file-manager';\nexport * from './node-sql-to-serialization';\n"],"names":[],"mappings":";;uBAAc;uBACA;uBACA;uBACA;uBACA;uBACA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/meerkat-node",
-  "version": "0.0.96",
+  "version": "0.0.98",
   "dependencies": {
     "@swc/helpers": "~0.5.0",
     "@devrev/meerkat-core": "*",

package/src/index.d.ts

@@ -1,8 +1,6 @@
 export * from './cube-to-sql-with-resolution/cube-to-sql-with-resolution';
 export * from './cube-to-sql/cube-to-sql';
-export * from './duckdb-singleton';
-export * from './node-sql-to-serialization';
-export { convertCubeStringToTableSchema };
-import { convertCubeStringToTableSchema } from '@devrev/meerkat-core';
 export * from './duckdb-manager/duckdb-manager';
+export * from './duckdb-singleton';
 export * from './file-manager/file-manager';
+export * from './node-sql-to-serialization';