@or-sdk/pgsql 1.0.3-beta.2074.0 → 1.0.3-beta.2079.0

package/src/Pgsql.ts

@@ -1,38 +1,42 @@
-import _ from 'lodash';
 import { Base, CalApiParams, List, MakeApiUrlData, makeList } from '@or-sdk/base';
 import { LIST_SCHEMAS_QUERY, SERVICE_KEY } from './constants';
 import {
   AddColumnsArgs,
   CreateDatabaseParams,
-  CreateTableArgs,
+  CreateDatabaseResponse, CreateTableArgs,
   DatabaseItem,
-  DeleteRowsArgs, DropDatabaseResponse, EditDatabaseParams, EditRowArgs,
-  ExecuteQueryArgs, ExecuteQueryResponse, GetDatabaseConnectionResponse, GetDBSizeResult, GetTableDataProps, InsertArgs,
+  DeleteRowsArgs, DropDatabaseResponse, EditRowArgs,
+  ExecuteQueryArgs, ExecuteQueryResponse, GetDBSizeResult, InsertArgs,
   ListDatabasesResponse,
-  PgsqlConfig, QueryField, Row, SelectAllArgs,
+  PgsqlConfig, Row, SelectAllArgs,
 } from './types';
 import {
   createSchemaQuery,
   getAddColumnsQuery,
   getCreateTableQuery,
+  getDeleteRowsQuery,
   getDropSchemaQuery,
-  getDropTableQuery, getGenerateTableSchemaQuery,
+  getDropTableQuery, getEditRowQuery, getGenerateTableSchemaQuery,
   getGetPrimaryKeysQuery,
-  getListTablesQuery, getSelectAllCountQuery, getSelectAllQuery, splitPrimaryKeys,
+  getInsertQueries,
+  getListTablesQuery, getSelectAllCountQuery, getSelectAllQuery,
 } from './utils';
 
 
 export class Pgsql extends Base {
+  private isExternal?: boolean;
+
   constructor(params: PgsqlConfig) {
-    const { token, discoveryUrl, accountId, pgsqlUrl, feature = 'master' } = params;
+    const { token, discoveryUrl, accountId, pgsqlUrl, version = 'master', isExternal } = params;
     super({
       token,
       discoveryUrl,
       serviceKey: SERVICE_KEY,
       accountId,
       serviceUrl: pgsqlUrl,
-      feature,
+      feature: version,
     });
+    this.isExternal = isExternal;
   }
 
   /**
@@ -52,7 +56,7 @@ export class Pgsql extends Base {
       (params.params as any).feature = this.feature;
     }
 
-    return this.callApiV2<T>(params);
+    return this.callApi<T>(params);
   }
 
   makeApiUrl(data: MakeApiUrlData): string {
@@ -66,19 +70,17 @@ export class Pgsql extends Base {
    * ```typescript
    * const result = await pgsql.executeQuery({
    *   query: 'select * from table',
-   *   database: 'db-name',
-   *   isExternal: false,
-   *   params: [],
+   *   database: 'db-name'
    * });
    * ```
    */
-  public async executeQuery<T>({ query, params, database, isExternal = false }: ExecuteQueryArgs): Promise<ExecuteQueryResponse<T>> {
+  public async executeQuery<T>({ query, params, database }: ExecuteQueryArgs): Promise<ExecuteQueryResponse<T>> {
     return this.makeRequest<ExecuteQueryResponse<T>>({
       data: {
         query,
         params,
         database,
-        isExternal,
+        isExternal: this.isExternal,
       },
       method: 'POST',
       route: 'query',
@@ -90,7 +92,6 @@ export class Pgsql extends Base {
    * ```typescript
    * const databaseList = await pgsql.listDatabases();
    * ```
-   * @returns {Array} database names
    */
   public async listDatabases(): Promise<List<DatabaseItem>> {
     const { databases } = await this.makeRequest<ListDatabasesResponse>({
@@ -107,12 +108,10 @@ export class Pgsql extends Base {
    * const result = await pgsql.createDatabase({ database: 'db-name' });
    * ```
    */
-  public async createDatabase({ database, description, imageUrl, externalCredentials }: CreateDatabaseParams): Promise<void> {
-    return this.makeRequest<void>({
+  public async createDatabase({ database, externalCredentials }: CreateDatabaseParams): Promise<CreateDatabaseResponse> {
+    return this.makeRequest<CreateDatabaseResponse>({
       data: {
         database,
-        description,
-        imageUrl,
         externalCredentials,
       },
       method: 'PUT',
@@ -121,36 +120,32 @@ export class Pgsql extends Base {
   }
 
   /**
-   * Edit database
+   * Get database info
+   *
+   * @deprecated route not available
    * ```typescript
-   * const result = await pgsql.editDatabase({ database: 'db-name' });
+   * const result = await pgsql.getDatabaseInfo({ database: 'db-name' });
    * ```
    */
-  public async editDatabase({ id, description, imageUrl, externalCredentials }: EditDatabaseParams): Promise<void> {
-    return this.makeRequest<void>({
-      data: {
-        id,
-        description,
-        imageUrl,
-        externalCredentials,
-      },
-      method: 'PUT',
-      route: 'edit-databases',
-    });
-  }
+  // TODO: uncomment or replace route?
+  // public async getDatabaseInfo({ database }: { database: string; }): Promise<unknown> {
+  //   return this.callApi<unknown>({
+  //     method: 'GET',
+  //     route: `databases/${encodeURIComponent(database)}`
+  //   })
+  // }
 
   /**
    * Drop database
    * ```typescript
-   * const result = await pgsql.dropDatabase({ database: 'db-name', isExternal: false, id: '1231-213123-123123' });
+   * const result = await pgsql.dropDatabase({ database: 'db-name' });
    * ```
    */
-  public async dropDatabase({ database, isExternal = false, id }: { database: string; isExternal?: boolean; id?: string;}): Promise<DropDatabaseResponse> {
+  public async dropDatabase({ database, isExternal }: { database: string; isExternal?: boolean;}): Promise<DropDatabaseResponse> {
     return this.makeRequest<DropDatabaseResponse>({
       data: {
         database,
         isExternal,
-        id,
       },
       method: 'DELETE',
       route: 'databases',
@@ -160,74 +155,67 @@ export class Pgsql extends Base {
   /**
    * List tables
    * ```typescript
-   * const result = await pgsql.listTables({ database: 'db-name', schema: 'schema-name', isExternal: false });
+   * const result = await pgsql.listTables({ database: 'db-name', schema: 'schema-name' });
    * ```
    */
-  public async listTables({ database, schema, isExternal }: { database: string; schema: string; isExternal: boolean; }): Promise<List<string>> {
+  public async listTables({ database, schema = 'public' }: { database: string; schema?: string; }): Promise<List<string>> {
     const { rows } = await this.executeQuery<{ table_name: string; }>({
       query: getListTablesQuery(schema),
       database,
-      isExternal,
     });
-
     return makeList<string>(rows.map(x => x.table_name));
   }
 
   /**
    * List schemas
    * ```typescript
-   * const result = await pgsql.listSchemas({ database: 'db-name', isExternal: false });
+   * const result = await pgsql.listSchemas({ database: 'db-name' });
    * ```
    */
-  public async listSchemas({ database, isExternal }: { database: string; isExternal: boolean; }): Promise<List<string>> {
+  public async listSchemas({ database }: { database: string; }): Promise<List<string>> {
     const { rows } = await this.executeQuery<{ schema_name: string; }>({
       query: LIST_SCHEMAS_QUERY,
       database,
-      isExternal,
     });
-
     return makeList<string>(rows.map(x => x.schema_name));
   }
 
   /**
    * Create schema
    * ```typescript
-   * const result = await pgsql.createSchema({ database: 'db-name', schema: 'schema-name', isExternal: false });
+   * const result = await pgsql.createSchema({ database: 'db-name', schema: 'schema-name' });
    * ```
    */
-  public async createSchema({ database, schema, isExternal }: { database: string; schema: string; isExternal: boolean; }): Promise<ExecuteQueryResponse<void>> {
+  public async createSchema({ database, schema }: { database: string; schema: string; }): Promise<ExecuteQueryResponse<void>> {
     return this.executeQuery<void>({
       query: createSchemaQuery(schema),
       database,
-      isExternal,
     });
   }
 
   /**
    * Drop schema
    * ```typescript
-   * const result = await pgsql.dropSchema({ database: 'db-name', schema: 'schema-name', isExternal: false });
+   * const result = await pgsql.dropSchema({ database: 'db-name', schema: 'schema-name' });
    * ```
    */
-  public async dropSchema({ database, schema, isExternal }: { database: string; schema: string; isExternal: boolean; }): Promise<ExecuteQueryResponse<void>> {
+  public async dropSchema({ database, schema }: { database: string; schema: string; }): Promise<ExecuteQueryResponse<void>> {
     return this.executeQuery<void>({
       query: getDropSchemaQuery(schema),
       database,
-      isExternal,
     });
   }
 
   /**
    * Drop table
    * ```typescript
-   * const result = await pgsql.dropSchema({ database: 'db-name', schema: 'schema-name', table: 'table-name', isExternal: false });
+   * const result = await pgsql.dropSchema({ database: 'db-name', schema: 'schema-name', table: 'table-name' });
    * ```
    */
-  public async dropTable({ database, schema, table, isExternal }: { database: string; schema: string; table: string; isExternal: boolean; }): Promise<ExecuteQueryResponse<void>> {
+  public async dropTable({ database, schema, table }: { database: string; schema: string; table: string; }): Promise<ExecuteQueryResponse<void>> {
     return this.executeQuery<void>({
       query: getDropTableQuery(schema, table),
       database,
-      isExternal,
     });
   }
 
@@ -242,16 +230,14 @@ export class Pgsql extends Base {
    *    { name: 'col1', type: 'integer' },
    *    { name: 'col2', type: 'text' }
    *   ],
-   *   primaryKey: 'col1,col2',
-   *   isExternal: false
+   *   primaryKey: 'col1,col2'
    * });
    * ```
    */
-  public async createTable({ database, schema, table, columns, primaryKey, isExternal }: CreateTableArgs): Promise<ExecuteQueryResponse<void>> {
+  public async createTable({ database, schema, table, columns, primaryKey }: CreateTableArgs): Promise<ExecuteQueryResponse<void>> {
     return this.executeQuery<void>({
       query: getCreateTableQuery(schema, table, columns, primaryKey),
       database,
-      isExternal,
     });
   }
 
@@ -266,15 +252,13 @@ export class Pgsql extends Base {
    *    { name: 'col1', type: 'integer' },
    *    { name: 'col2', type: 'text' }
    *   ],
-   *   isExternal: false
    * });
    * ```
    */
-  public async addColumns({ database, schema, table, columns, isExternal }: AddColumnsArgs): Promise<ExecuteQueryResponse<void>> {
+  public async addColumns({ database, schema, table, columns }: AddColumnsArgs): Promise<ExecuteQueryResponse<void>> {
     return this.executeQuery<void>({
       query: getAddColumnsQuery(schema, table, columns),
       database,
-      isExternal,
     });
   }
 
@@ -289,101 +273,52 @@ export class Pgsql extends Base {
    *    { col1: 'value' }
    *   ],
    *   chunkSize: 300,
-   *   context: { progress: 0 } // progress of insert will be set from 0 to 100,
-   *   isExternal: false
+   *   context: { progress: 0 } // progress of insert will be set from 0 to 100
    * });
    * ```
    */
-  public async insert({ database, schema, table, rows, chunkSize = 300, context, isExternal }: InsertArgs): Promise<ExecuteQueryResponse<unknown>[]> {
-    let params: any[] = [];
-    const addParam = (val: any) => {params.push(val);return `$${params.length}`;};
+  public async insert({ database, schema, table, rows, chunkSize = 300, context }: InsertArgs): Promise<ExecuteQueryResponse<void>[]> {
     const res = [];
-    if (!_.isArray(rows)) rows = [rows];
-    const allKeys = {};
-    rows.forEach(x => Object.assign(allKeys, x));
-    const keys = Object.keys(allKeys);
-    const stringifyRow = (row: any) => `${keys.map(key => addParam(row[key])).join(', ')}`;
-
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-ignore
-    for (const [index, chunk] of _.chunk(rows, chunkSize).entries()) {
-      params = [];
-      const query = `insert into  ${schema}.${table} (${keys.join(', ')})
-values (${chunk.map(stringifyRow).join('), (')});`;
-      res.push(await this.executeQuery({
-        query,
-        database,
-        isExternal,
-        params,
-      }));
-      if (context) context.progress = (index + 1) / (rows.length / chunkSize) * 100;
-    }
-
-    return res;
-  }
-
-
-  // TODO: add method description and example
-  // TODO: add context ass in selectAll and rethink this two methods
-  public async getDatabaseRows({ database, schema, table, chunkSize = 1000, offset = 0, limit, isExternal, params }: GetTableDataProps): Promise<{ rows: List<Row>; fields: QueryField[]; }> {
-    let fields: QueryField[] = [];
-    let rows, result: Row[] = [];
-
-    // TODO: add order by primary key?
-    // const query = `select * from ${schema}.${table} order by int`;
-    const query = `select * from ${schema}.${table}`;
 
-    if (limit && limit < chunkSize) chunkSize = limit;
+    const queries = getInsertQueries(schema, table, rows, chunkSize);
 
-    do {
-      ({ rows, fields } = await this.executeQuery<Row>({
-        query: getSelectAllQuery(query, offset, chunkSize),
+    for (const [index, query] of Array.from(queries.entries())) {
+      res.push(await this.executeQuery<void>({
+        query,
         database,
-        isExternal,
-        params,
       }));
-      offset += chunkSize;
-      result = result.concat(rows);
 
-      if (limit && result.length >= limit) {
-        result = result.slice(0, limit);
-        break;
+      if (context) {
+        context.progress = Math.min((index + 1) / (rows.length / Math.min(chunkSize, rows.length)), 1) * 100;
       }
-    } while (rows.length === chunkSize);
+    }
 
-    return {
-      rows: makeList<Row>(result),
-      fields,
-    };
+    return res;
   }
 
-
   /**
    * Select all
    * ```typescript
    * const result = await pgsql.selectAll({
    *   database: 'db-name',
-   *   query: 'select * from table where id = $1', // must be select only, without limit and offset
+   *   query: 'select * from table', // must be select only, without limit and offset
    *   chunkSize: 300,
    *   offset: 0,
    *   limit: 0,
    *   context: { progress: 0, total: 0 } // progress of select will be set from 0 to 100
-   *   isExternal: false,
-   *   params: ['123']
    * });
    * ```
    */
-  public async selectAll({ database, query, context, chunkSize = 1000, offset = 0, limit, isExternal, params }: SelectAllArgs): Promise<List<Row>> {
+  public async selectAll({ database, query, context, chunkSize = 1000, offset = 0, limit }: SelectAllArgs): Promise<List<Row>> {
     let count: number, rows, result: Row[] = [];
-
-    if (limit && limit < chunkSize) chunkSize = limit;
+    if (limit && limit < chunkSize) {
+      chunkSize = limit;
+    }
 
     if (context) {
       const { rows } = await this.executeQuery<{ count: number; }>({
         query: getSelectAllCountQuery(query),
         database,
-        isExternal,
-        params,
       });
       count = rows[0].count;
       context.total = count;
@@ -393,16 +328,12 @@ values (${chunk.map(stringifyRow).join('), (')});`;
       ({ rows } = await this.executeQuery<Row>({
         query: getSelectAllQuery(query, offset, chunkSize),
         database,
-        isExternal,
-        params,
       }));
       offset += chunkSize;
       result = result.concat(rows);
-
       if (context) {
         context.progress = Math.min(offset / count! * 100, 100);
       }
-
       if (limit && result.length >= limit) {
         result = result.slice(0, limit);
         break;
@@ -415,14 +346,13 @@ values (${chunk.map(stringifyRow).join('), (')});`;
   /**
    * Get primary keys
    * ```typescript
-   * const result = await pgsql.getPrimaryKeys({ database: 'db-name', schema: 'schema-name', table: 'table-name', isExternal: false });
+   * const result = await pgsql.getPrimaryKeys({ database: 'db-name', schema: 'schema-name', table: 'table-name' });
    * ```
    */
-  public async getPrimaryKeys({ database, schema, table, isExternal }: { database: string; schema: string; table: string; isExternal: boolean; }): Promise<string> {
+  public async getPrimaryKeys({ database, schema, table }: { database: string; schema: string; table: string; }): Promise<string> {
     const { rows } = await this.executeQuery<{ pk: string; }>({
       database,
       query: getGetPrimaryKeysQuery(schema, table),
-      isExternal,
     });
     return rows[0].pk;
   }
@@ -438,28 +368,13 @@ values (${chunk.map(stringifyRow).join('), (')});`;
    *   value: 'new_value',
    *   row: { pk: 'pk_val', col1: 'old_value' },
    *   primaryKeys: 'pk',
-   *   isExternal: false
    * });
    * ```
    */
-  public async editRow({ database, schema, table, key, value, row, primaryKeys, isExternal }: EditRowArgs): Promise<ExecuteQueryResponse<void>> {
-    // TODO: maybe move query and params to utils and return both
-    const params: any[] = [];
-    const addParam = (val: any) => {
-      params.push(val);
-      return `$${params.length}`;
-    };
-
-    const pk = splitPrimaryKeys(primaryKeys);
-
-    // TODO: move query to utils
+  public async editRow({ database, schema, table, key, value, row, primaryKeys }: EditRowArgs): Promise<ExecuteQueryResponse<void>> {
     return this.executeQuery({
       database,
-      query: `update ${schema}.${table}
-set ${key} = ${addParam(value)}
-where ${pk.map(primaryKey => `${primaryKey} = ${addParam(row[primaryKey])}`).join(' AND ')}`,
-      isExternal,
-      params,
+      query: getEditRowQuery(schema, table, key, value, row, primaryKeys),
     });
   }
 
@@ -474,27 +389,13 @@ where ${pk.map(primaryKey => `${primaryKey} = ${addParam(row[primaryKey])}`).joi
    *    { pk: 'pk_val', col1: 'value' }
    *   ],
    *   primaryKeys: 'pk',
-   *   isExternal: false
    * });
    * ```
    */
-  public async deleteRows({ database, schema, table, rows, primaryKeys, isExternal }: DeleteRowsArgs): Promise<ExecuteQueryResponse<void>> {
-    const params: any[] = [];
-    const addParam = (val: any) => {
-      params.push(val);
-      return `$${params.length}`;
-    };
-
-    const pk = splitPrimaryKeys(primaryKeys);
-    // TODO: move query to util
-    const query = `delete from ${schema}.${table}
-        where (${rows.map(row => `${pk.map(primaryKey => `${primaryKey} = ${addParam(row[primaryKey])}`).join(' AND ')}`).join(') \nOR (')})`;
-
+  public async deleteRows({ database, schema, table, rows, primaryKeys }: DeleteRowsArgs): Promise<ExecuteQueryResponse<void>> {
     return this.executeQuery({
       database,
-      query,
-      isExternal,
-      params,
+      query: getDeleteRowsQuery(schema, table, rows, primaryKeys),
     });
   }
 
@@ -504,11 +405,10 @@ where ${pk.map(primaryKey => `${primaryKey} = ${addParam(row[primaryKey])}`).joi
    * const result = await pgsql.generateTableSchema({ database: 'db-name', schema: 'schema-name', table: 'table-name' });
    * ```
    */
-  public async generateTableSchema({ database, schema, table, isExternal }: { database: string; schema: string; table: string; isExternal: boolean; }): Promise<string> {
+  public async generateTableSchema({ database, schema, table }: { database: string; schema: string; table: string; }): Promise<string> {
     const { rows } = await this.executeQuery<{ code: string; }>({
       database,
       query: getGenerateTableSchemaQuery(schema, table),
-      isExternal,
     });
 
     return rows[0].code;
@@ -526,28 +426,4 @@ where ${pk.map(primaryKey => `${primaryKey} = ${addParam(row[primaryKey])}`).joi
       route: 'size',
     });
   }
-
-  /**
-   * Get database connection config. Works only in LAMBDAS in private web.
-   * ```typescript
-   * const connectionConfig = await pgsql.getDatabaseConnections('database');
-   * ```
-   */
-  public async getDatabaseConnections(database: string): Promise<GetDatabaseConnectionResponse> {
-    return await this.makeRequest<GetDatabaseConnectionResponse>({
-      method: 'GET',
-      params: { database },
-      route: 'database-connection',
-    });
-  }
-
-  /**
-   * @param {*} value any value to encode and paste to pg query
-   */
-  encodeValue(value: never) {
-    if (_.isUndefined(value) || value === '' || _.isNull(value)) return 'NULL';
-    if (_.isString(value)) return _.replace(value, '\'', '\'\'');
-    if (_.isNumber(value) || _.isBoolean(value)) return value;
-    return `'${JSON.stringify(value).replaceAll('\'', '\'\'')}'`;
-  }
 }

package/src/types.ts

@@ -22,9 +22,14 @@ export type PgsqlConfig = {
   pgsqlUrl?: string;
 
   /**
-   * Api feature
+   * Api version
    */
-  feature?: string;
+  version?: string;
+
+  /**
+   * use external database
+   */
+  isExternal?: boolean;
 };
 
 export type QueryField = {
@@ -49,13 +54,26 @@ export type ExecuteQueryResponse<T> = {
 
 export type ExecuteQueryArgs = {
   query: string;
-  params?: any[];
+  params?: {
+    [key: string]: unknown;
+  };
   database: string;
-  isExternal?: boolean;
+};
+
+export type CreateDatabaseResponse = {
+  ok: number;
+  result: [
+    unknown[],
+    unknown[],
+  ];
+};
+
+export type ListDatabasesResponseItem = {
+  name: string;
 };
 
 export type ListDatabasesResponse = {
-  databases: DatabaseItem[];
+  databases: ListDatabasesResponseItem[];
 };
 
 export type DropDatabaseResponse = {
@@ -69,7 +87,7 @@ export type GetDBSizeResult = {
 
 export type TableColumn = {
   name: string;
-  type: string;
+  type: number;
 };
 
 export type CreateTableArgs = {
@@ -78,7 +96,6 @@ export type CreateTableArgs = {
   table: string;
   columns: TableColumn[];
   primaryKey: string;
-  isExternal: boolean;
 };
 
 export type AddColumnsArgs = {
@@ -86,7 +103,6 @@ export type AddColumnsArgs = {
   schema: string;
   table: string;
   columns: TableColumn[];
-  isExternal: boolean;
 };
 
 export type Row = {
@@ -102,19 +118,9 @@ export type InsertArgs = {
   context?: {
     progress?: number;
   };
-  isExternal: boolean;
 };
 
-export type GetTableDataProps = {
-  database: string;
-  schema: string;
-  table: string;
-  isExternal: boolean;
-  chunkSize?: number;
-  offset?: number;
-  limit?: number;
-  params?: any[];
-};
+export type EncodedValue = string | number | boolean;
 
 export type SelectAllArgs = {
   database: string;
@@ -126,8 +132,6 @@ export type SelectAllArgs = {
   chunkSize?: number;
   offset?: number;
   limit?: number;
-  isExternal: boolean;
-  params?: any[];
 };
 
 export type EditRowArgs = {
@@ -138,7 +142,6 @@ export type EditRowArgs = {
   value: unknown;
   row: Row;
   primaryKeys: string;
-  isExternal: boolean;
 };
 
 export type DeleteRowsArgs = {
@@ -147,26 +150,15 @@ export type DeleteRowsArgs = {
   table: string;
   rows: Row[];
   primaryKeys: string;
-  isExternal: boolean;
 };
 
 export type DatabaseItem = {
-  id: string;
-  accountId: string;
   name: string;
-  isExternal: boolean;
-  uniqueName: string;
-  host?: string;
-  port?: number;
-  username?: string;
-  description?: string;
-  imageUrl?: string;
+  isExternal?: boolean;
 };
 
 export type CreateDatabaseParams = {
   database: string;
-  description?: string;
-  imageUrl?: string;
   externalCredentials?: {
     host: string;
     port: number;
@@ -174,23 +166,3 @@ export type CreateDatabaseParams = {
     user: string;
   };
 };
-
-export type EditDatabaseParams = {
-  id: string;
-  description?: string;
-  imageUrl?: string;
-  externalCredentials?: {
-    host?: string;
-    port?: number;
-    password?: string;
-    user?: string;
-  };
-};
-
-export type GetDatabaseConnectionResponse = {
-  user: string;
-  host_master: string;
-  database: string;
-  password: string;
-  port: number;
-};