Merge pull request #34 from RelationalAI/dg-list-txns-filter

Added filtering transactions and tags for exec*

Author: Denis Gursky

examples/execAsync.ts

@@ -25,13 +25,15 @@ async function run(
   queryString: string,
   readonly: boolean,
   poll: boolean,
+  tag: string,
   profile?: string,
 ) {
   const config = await readConfig(profile);
   const client = new Client(config);
+  const tags = tag ? [tag] : undefined;
   const result = poll
-    ? await client.exec(database, engine, queryString, [], readonly)
-    : await client.execAsync(database, engine, queryString, [], readonly);
+    ? await client.exec(database, engine, queryString, [], readonly, tags)
+    : await client.execAsync(database, engine, queryString, [], readonly, tags);
 
   showTransactionResult(result);
 }
@@ -43,6 +45,7 @@ async function run(
     .requiredOption('-d, --database <type>', 'database name')
     .requiredOption('-e, --engine <type>', 'engine name')
     .requiredOption('-c, --command <type>', 'rel source string')
+    .option('-t, --tag <type>', 'tag', '')
     .option('-r, --readonly', 'readonly', false)
     .option('--poll', 'poll results', false)
     .option('-p, --profile <type>', 'profile', 'default')
@@ -56,6 +59,7 @@ async function run(
       options.command,
       options.readonly,
       options.poll,
+      options.tag,
       options.profile,
     );
   } catch (error: any) {

examples/listTransactions.ts

@@ -19,10 +19,11 @@ import { Command } from 'commander';
 import { Client, readConfig } from '../index.node';
 import { show } from './show';
 
-async function run(profile?: string) {
+async function run(tag: string, profile?: string) {
   const config = await readConfig(profile);
   const client = new Client(config);
-  const result = await client.listTransactions();
+  const options = tag ? { tags: [tag] } : undefined;
+  const result = await client.listTransactions(options);
 
   show(result);
 }
@@ -31,12 +32,13 @@ async function run(profile?: string) {
   const program = new Command();
 
   const options = program
+    .option('-t, --tag <type>', 'tag', '')
     .option('-p, --profile <type>', 'profile', 'default')
     .parse(process.argv)
     .opts();
 
   try {
-    await run(options.profile);
+    await run(options.tag, options.profile);
   } catch (error: any) {
     console.error(error.toString());
   }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@relationalai/rai-sdk-javascript",
   "description": "RelationalAI SDK for JavaScript",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "author": {
     "name": "RelationalAI",
     "url": "https://relational.ai"

src/query/execAsyncApi.test.ts

@@ -44,6 +44,7 @@ describe('QueryAsyncApi', () => {
         nowait_durable: false,
         readonly: true,
         v1_inputs: [],
+        tags: [],
       })
       .reply(200, response);
     const result = await api.execAsync(database, engine, query, [], true);

src/query/execAsyncApi.ts

@@ -33,13 +33,15 @@ export class ExecAsyncApi extends TransactionAsyncApi {
     queryString: string,
     inputs: QueryInput[] = [],
     readonly = true,
+    tags: string[] = [],
   ) {
     const transaction: TransactionAsyncPayload = {
       dbname: database,
       query: queryString,
       nowait_durable: false,
       readonly,
       v1_inputs: inputs.map(input => makeQueryInput(input.name, input.value)),
+      tags,
     };
 
     if (engine) {
@@ -55,6 +57,7 @@ export class ExecAsyncApi extends TransactionAsyncApi {
     queryString: string,
     inputs: QueryInput[] = [],
     readonly = true,
+    tags: string[] = [],
     interval = 3 * 1000, // 3 seconds
     timeout = Number.POSITIVE_INFINITY,
   ) {
@@ -64,6 +67,7 @@ export class ExecAsyncApi extends TransactionAsyncApi {
       queryString,
       inputs,
       readonly,
+      tags,
     );
     const txnId = result.transaction.id;
 

src/transaction/transactionAsyncApi.test.ts

@@ -111,6 +111,22 @@ describe('TransactionAsyncApi', () => {
     expect(result).toEqual(mockTransactions);
   });
 
+  it('should list transactions with params', async () => {
+    const response = {
+      transactions: mockTransactions,
+    };
+    const query = {
+      engine_name: 'test_engine',
+      tags: ['tag1', 'tag2'],
+    };
+    const scope = nock(baseUrl).get(path).query(query).reply(200, response);
+    const result = await api.listTransactions(query);
+
+    scope.done();
+
+    expect(result).toEqual(mockTransactions);
+  });
+
   it('should get transaction', async () => {
     const response = {
       transaction: mockTransactions[0],

src/transaction/transactionAsyncApi.ts

@@ -22,6 +22,7 @@ import {
   TransactionAsyncCompact,
   TransactionAsyncFile,
   TransactionAsyncPayload,
+  TransactionListOptions,
   TransactionMetadata,
 } from './types';
 
@@ -50,8 +51,8 @@ export class TransactionAsyncApi extends Base {
     };
   }
 
-  async listTransactions() {
-    const result = await this.get<ListResponse>(ENDPOINT);
+  async listTransactions(options?: TransactionListOptions) {
+    const result = await this.get<ListResponse>(ENDPOINT, options);
 
     return result.transactions;
   }

src/transaction/types.ts

@@ -179,6 +179,7 @@ export type TransactionAsyncPayload = {
   engine_name?: string;
   query: string;
   v1_inputs: Relation[];
+  tags?: string[];
 };
 
 export type TransactionAsync = {
@@ -197,6 +198,7 @@ export type TransactionAsync = {
   query: string;
   user_agent: string;
   abort_reason?: string;
+  tags?: string[];
 };
 
 export type TransactionAsyncCompact = {
@@ -226,3 +228,10 @@ export type TransactionAsyncResult = {
   problems?: Problem[];
   results: ArrowRelation[];
 };
+
+export type TransactionListOptions = {
+  database_name?: string | string[];
+  engine_name?: string | string[];
+  state?: TransactionAsyncState | TransactionAsyncState[];
+  tags?: string | string[];
+};