dbgate-types 5.3.4 → 5.4.0

package/alter-processor.d.ts

@@ -15,5 +15,12 @@ export interface AlterProcessor {
   recreateTable(oldTable: TableInfo, newTable: TableInfo);
   createSqlObject(obj: SqlObjectInfo);
   dropSqlObject(obj: SqlObjectInfo);
-  fillPreloadedRows(table: NamedObjectInfo, oldRows: any[], newRows: any[], key: string[], insertOnly: string[]);
+  fillPreloadedRows(
+    table: NamedObjectInfo,
+    oldRows: any[],
+    newRows: any[],
+    key: string[],
+    insertOnly: string[],
+    autoIncrementColumn: string
+  );
 }

package/dbinfo.d.ts

@@ -94,7 +94,19 @@ export interface TableInfo extends DatabaseObjectInfo {
   __isDynamicStructure?: boolean;
 }
 
-export interface CollectionInfo extends DatabaseObjectInfo {}
+export interface CollectionInfo extends DatabaseObjectInfo {
+  // all known columns with definition (only used in Cassandra)
+  knownColumns?: ColumnInfo[];
+
+  // unique combination of columns (should be contatenation of partitionKey and clusterKey)
+  uniqueKey?: ColumnReference[];
+
+  // partition key columns
+  partitionKey?: ColumnReference[]
+
+  // unique key inside partition
+  clusterKey?: ColumnReference[];  
+}
 
 export interface ViewInfo extends SqlObjectInfo {
   columns: ColumnInfo[];

package/dialect.d.ts

@@ -34,6 +34,7 @@ export interface SqlDialect {
   dropCheck?: boolean;
 
   dropReferencesWhenDropTable?: boolean;
+  requireFromDual?: boolean;
 
   predefinedDataTypes: string[];
 

package/engines.d.ts

@@ -2,7 +2,17 @@ import stream from 'stream';
 import { QueryResult } from './query';
 import { SqlDialect } from './dialect';
 import { SqlDumper } from './dumper';
-import { DatabaseInfo, NamedObjectInfo, TableInfo, ViewInfo, ProcedureInfo, FunctionInfo, TriggerInfo } from './dbinfo';
+import {
+  DatabaseInfo,
+  NamedObjectInfo,
+  TableInfo,
+  ViewInfo,
+  ProcedureInfo,
+  FunctionInfo,
+  TriggerInfo,
+  CollectionInfo,
+} from './dbinfo';
+import { FilterBehaviour } from './filter-type';
 
 export interface StreamOptions {
   recordset: (columns) => void;
@@ -40,6 +50,9 @@ export interface ReadCollectionOptions {
   countDocuments?: boolean;
   skip?: number;
   limit?: number;
+  condition?: any;
+  aggregate?: CollectionAggregateDefinition;
+  sort?: CollectionSortDefinition;
 }
 
 export interface NewObjectTemplate {
@@ -71,7 +84,52 @@ export interface ServerSummary {
   databases: ServerSummaryDatabase[];
 }
 
-export interface EngineDriver {
+export type CollectionAggregateFunction = 'count' | 'sum' | 'avg' | 'min' | 'max';
+export interface CollectionAggregateDefinition {
+  condition: any; // SQL tree condition
+  groupByColumns: string[];
+  aggregateColumns: {
+    alias: string;
+    aggregateFunction: CollectionAggregateFunction;
+    columnArgument?: string;
+  }[];
+}
+
+export interface CollectionSortDefinitionItem {
+  columnName: string;
+  direction: 'ASC' | 'DESC';
+}
+
+export type CollectionSortDefinition = CollectionSortDefinitionItem[];
+
+export interface DataEditorTypesBehaviour {
+  parseSqlNull?: boolean;
+  parseJsonNull?: boolean;
+  parseJsonBoolean?: boolean;
+  parseNumber?: boolean;
+  parseJsonArray?: boolean;
+  parseJsonObject?: boolean;
+  parseHexAsBuffer?: boolean;
+  parseObjectIdAsDollar?: boolean;
+  parseDateAsDollar?: boolean;
+
+  explicitDataType?: boolean;
+  supportNumberType?: boolean;
+  supportStringType?: boolean;
+  supportBooleanType?: boolean;
+  supportDateType?: boolean;
+  supportNullType?: boolean;
+  supportJsonType?: boolean;
+  supportObjectIdType?: boolean;
+
+  supportFieldRemoval?: boolean;
+}
+
+export interface FilterBehaviourProvider {
+  getFilterBehaviour(dataType: string, standardFilterBehaviours: { [id: string]: FilterBehaviour }): FilterBehaviour;
+}
+
+export interface EngineDriver extends FilterBehaviourProvider {
   engine: string;
   title: string;
   defaultPort?: number;
@@ -79,6 +137,7 @@ export interface EngineDriver {
   editorMode?: string;
   readOnlySessions: boolean;
   supportedKeyTypes: SupportedDbKeyType[];
+  dataEditorTypesBehaviour: DataEditorTypesBehaviour;
   supportsDatabaseUrl?: boolean;
   supportsDatabaseDump?: boolean;
   supportsServerSummary?: boolean;
@@ -89,8 +148,20 @@ export interface EngineDriver {
   profilerChartAggregateFunction?: string;
   profilerChartMeasures?: { label: string; field: string }[];
   isElectronOnly?: boolean;
+
+  collectionSingularLabel?: string;
+  collectionPluralLabel?: string;
+  collectionNameLabel?: string;
+  newCollectionFormParams?: any[];
+
   supportedCreateDatabase?: boolean;
-  showConnectionField?: (field: string, values: any) => boolean;
+  showConnectionField?: (
+    field: string,
+    values: any,
+    {
+      config: {},
+    }
+  ) => boolean;
   showConnectionTab?: (tab: 'ssl' | 'sshTunnel', values: any) => boolean;
   beforeConnectionSave?: (values: any) => any;
   databaseUrlPlaceholder?: string;
@@ -131,11 +202,12 @@ export interface EngineDriver {
   getAuthTypes(): EngineAuthType[];
   readCollection(pool: any, options: ReadCollectionOptions): Promise<any>;
   updateCollection(pool: any, changeSet: any): Promise<any>;
-  getCollectionUpdateScript(changeSet: any): string;
+  getCollectionUpdateScript(changeSet: any, collectionInfo: CollectionInfo): string;
   createDatabase(pool: any, name: string): Promise;
   dropDatabase(pool: any, name: string): Promise;
   getQuerySplitterOptions(usage: 'stream' | 'script' | 'editor'): any;
   script(pool: any, sql: string, options?: RunScriptOptions): Promise;
+  operation(pool: any, operation: {}, options?: RunScriptOptions): Promise;
   getNewObjectTemplates(): NewObjectTemplate[];
   // direct call of pool method, only some methods could be supported, on only some drivers
   callMethod(pool, method, args);
@@ -143,6 +215,13 @@ export interface EngineDriver {
   summaryCommand(pool, command, row): Promise<void>;
   startProfiler(pool, options): Promise<any>;
   stopProfiler(pool, profiler): Promise<void>;
+  getRedirectAuthUrl(connection, options): Promise<{ url: string; sid: string }>;
+  getAuthTokenFromCode(connection, options): Promise<string>;
+  getAccessTokenFromAuth(connection, req): Promise<string | null>;
+  getCollectionExportQueryScript(collection: string, condition: any, sort?: CollectionSortDefinition): string;
+  getCollectionExportQueryJson(collection: string, condition: any, sort?: CollectionSortDefinition): {};
+  getScriptTemplates(objectTypeField: keyof DatabaseInfo): { label: string; scriptTemplate: string }[];
+  getScriptTemplateContent(scriptTemplate: string, props: any): Promise<string>;
 
   analyserClass?: any;
   dumperClass?: any;

package/filter-type.d.ts

@@ -0,0 +1,19 @@
+export interface FilterBehaviour {
+  supportEquals?: boolean;
+  supportStringInclusion?: boolean;
+  supportEmpty?: boolean;
+  supportNumberLikeComparison?: boolean;
+  supportDatetimeComparison?: boolean;
+  supportDatetimeSymbols?: boolean;
+  supportNullTesting?: boolean;
+  supportExistsTesting?: boolean;
+  supportBooleanValues?: boolean;
+  supportSqlCondition?: boolean;
+  supportArrayTesting?: boolean;
+
+  allowStringToken?: boolean;
+  allowNumberToken?: boolean;
+  allowHexString?: boolean;
+  allowNumberDualTesting?: boolean;
+  allowObjectIdTesting?: boolean;
+}

package/index.d.ts

@@ -47,3 +47,4 @@ export * from './dbtypes';
 export * from './extensions';
 export * from './alter-processor';
 export * from './appdefs';
+export * from './filter-type';

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.3.4",
+  "version": "5.4.0",
   "name": "dbgate-types",
   "homepage": "https://dbgate.org/",
   "repository": {