api.exportDatabase()

​

api.exportDatabase()

• Unavailable with readOnly: true (throws an error).
• By default waits for the export, final compose, and storage entry persistence.
• CSV is the default and its dialect, headers, and byte map are indexed during upload.
• XLSX streams directly from the database through the native Storage writer into the final resumable upload, preserves database value types where Excel supports them, and runs a server-side COUNT(*) before starting. A failed export is discarded and can be retried by its job; a header row leaves 1,048,575 data rows available.
• By default the call completes synchronously in its current runtime. Set async: true to queue it on Processor and receive a jobId.
• Omit storageDestination for private user storage, use ROOT for Explorer root, or provide an accessible Explorer folder storageEntryId.

​

Signature

static exportDatabase<TAsync extends boolean = false>(
      name: string,
      options?: ExportDatabaseOptions & { async?: TAsync },
    ): Promise<
      TAsync extends true
        ? ExportDatabaseAcceptedResponse
        : TAsync extends false
          ? ExportDatabaseCompletedResponse
          : ExportDatabaseResponse
    >;

​

Example

const result = await api.exportDatabase('contracts', {
  format: 'xlsx',
  storageDestination: 'ROOT',
  fileName: 'contracts-full.xlsx',
  restricted: false,
  fields: ['contractId', 'customerId'],
  sort: { contractId: 'ASC' },
});

return result.storageEntryId;