dbgate-types 6.2.1 → 6.3.0

package/dialect.d.ts

@@ -17,6 +17,7 @@ export interface SqlDialect {
   defaultSchemaName?: string;
   enableConstraintsPerTable?: boolean;
   enableAllForeignKeys?: boolean;
+  enableForeignKeyChecks?: boolean;
   requireStandaloneSelectForScopeIdentity?: boolean;
   allowMultipleValuesInsert?: boolean;
 

package/engines.d.ts

@@ -41,6 +41,7 @@ export interface WriteTableOptions {
   createIfNotExists?: boolean;
   commitAfterInsert?: boolean;
   targetTableStructure?: TableInfo;
+  progressName?: string;
 }
 
 export interface EngineAuthType {
@@ -144,6 +145,31 @@ export interface DatabaseHandle<TClient = any> {
   treeKeySeparator?: string;
 }
 
+export type StreamResult = stream.Readable | (stream.Readable | stream.Writable)[];
+
+export interface CommandLineDefinition {
+  command: string;
+  args: string[];
+  env?: { [key: string]: string };
+  stdinFilePath?: string;
+}
+
+interface BackupRestoreSettingsBase {
+  database: string;
+  options?: { [key: string]: string };
+  argsFormat: 'shell' | 'spawn';
+}
+
+export interface BackupDatabaseSettings extends BackupRestoreSettingsBase {
+  outputFile: string;
+  selectedTables?: { pureName: string; schemaName?: string }[];
+  skippedTables?: { pureName: string; schemaName?: string }[];
+}
+
+export interface RestoreDatabaseSettings extends BackupRestoreSettingsBase {
+  inputFile: string;
+}
+
 export interface EngineDriver<TClient = any> extends FilterBehaviourProvider {
   engine: string;
   title: string;
@@ -154,7 +180,8 @@ export interface EngineDriver<TClient = any> extends FilterBehaviourProvider {
   supportedKeyTypes: SupportedDbKeyType[];
   dataEditorTypesBehaviour: DataEditorTypesBehaviour;
   supportsDatabaseUrl?: boolean;
-  supportsDatabaseDump?: boolean;
+  supportsDatabaseBackup?: boolean;
+  supportsDatabaseRestore?: boolean;
   supportsServerSummary?: boolean;
   supportsDatabaseProfiler?: boolean;
   requiresDefaultSortCriteria?: boolean;
@@ -165,6 +192,7 @@ export interface EngineDriver<TClient = any> extends FilterBehaviourProvider {
   // isElectronOnly?: boolean;
   supportsTransactions?: boolean;
   implicitTransactions?: boolean; // transaction is started with first SQL command, no BEGIN TRANSACTION is needed
+  premiumOnly?: boolean;
 
   collectionSingularLabel?: string;
   collectionPluralLabel?: string;
@@ -183,6 +211,7 @@ export interface EngineDriver<TClient = any> extends FilterBehaviourProvider {
   beforeConnectionSave?: (values: any) => any;
   databaseUrlPlaceholder?: string;
   defaultAuthTypeName?: string;
+  authTypeFirst?: boolean;
   defaultLocalDataCenter?: string;
   defaultSocketPath?: string;
   authTypeLabel?: string;
@@ -191,15 +220,11 @@ export interface EngineDriver<TClient = any> extends FilterBehaviourProvider {
   close(dbhan: DatabaseHandle<TClient>): Promise<any>;
   query(dbhan: DatabaseHandle<TClient>, sql: string, options?: QueryOptions): Promise<QueryResult>;
   stream(dbhan: DatabaseHandle<TClient>, sql: string, options: StreamOptions);
-  readQuery(dbhan: DatabaseHandle<TClient>, sql: string, structure?: TableInfo): Promise<stream.Readable>;
-  readJsonQuery(dbhan: DatabaseHandle<TClient>, query: any, structure?: TableInfo): Promise<stream.Readable>;
+  readQuery(dbhan: DatabaseHandle<TClient>, sql: string, structure?: TableInfo): Promise<StreamResult>;
+  readJsonQuery(dbhan: DatabaseHandle<TClient>, query: any, structure?: TableInfo): Promise<StreamResult>;
   // eg. PostgreSQL COPY FROM stdin
-  writeQueryFromStream(dbhan: DatabaseHandle<TClient>, sql: string): Promise<stream.Writable>;
-  writeTable(
-    dbhan: DatabaseHandle<TClient>,
-    name: NamedObjectInfo,
-    options: WriteTableOptions
-  ): Promise<stream.Writable>;
+  writeQueryFromStream(dbhan: DatabaseHandle<TClient>, sql: string): Promise<StreamResult>;
+  writeTable(dbhan: DatabaseHandle<TClient>, name: NamedObjectInfo, options: WriteTableOptions): Promise<StreamResult>;
   analyseSingleObject(
     dbhan: DatabaseHandle<TClient>,
     name: NamedObjectInfo,
@@ -262,6 +287,24 @@ export interface EngineDriver<TClient = any> extends FilterBehaviourProvider {
   // simple data type adapter
   adaptDataType(dataType: string): string;
   listSchemas(dbhan: DatabaseHandle<TClient>): SchemaInfo[];
+  backupDatabaseCommand(
+    connection: any,
+    settings: BackupDatabaseSettings,
+    externalTools: { [tool: string]: string }
+  ): CommandLineDefinition;
+  restoreDatabaseCommand(
+    connection: any,
+    settings: RestoreDatabaseSettings,
+    externalTools: { [tool: string]: string }
+  ): CommandLineDefinition;
+  transformNativeCommandMessage(
+    message: {
+      message: string;
+      severity: 'info' | 'error';
+    },
+    command: 'backup' | 'restore'
+  ): { message: string; severity: 'info' | 'error' | 'debug' } | null;
+  getNativeOperationFormArgs(operation: 'backup' | 'restore'): any[];
 
   analyserClass?: any;
   dumperClass?: any;

package/package.json

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