Skip to main content
  • Export records from a table to files. All tables can be exported, in full or partial (see columns_to_export and columns_to_skip). Additional filtering can be applied when using export table with expression through SQL. Default destination is KIFS, though other storage types (Azure, S3, GCS, and HDFS) are supported through datasink_name; see create_datasink.

    Server’s local file system is not supported. Default file format is delimited text. See options for different file types and different options for each file type. Table is saved to a single file if within max file size limits (may vary depending on datasink type). If not, then table is split into multiple files; these may be smaller than the max size limit.

    All filenames created are returned in the response.

    Parameters

    • table_name: string

      The name of the table whose records are to be exported.

    • filepath: string

      Path to data export target. If filepath has a file extension, it is read as the name of a file. If filepath is a directory, then the source table name with a random UUID appended will be used as the name of each exported file, all written to that directory. If filepath is a filename, then all exported files will have a random UUID appended to the given name. In either case, the target directory specified or implied must exist. The names of all exported files are returned in the response.

    • Optionaloptions: Record<string, string>

      Optional parameters.

    • Optionalcallback: GPUdbCallback

      Optional callback function

    Returns Promise<ExportRecordsToFilesResponse>

    Promise<Types.ExportRecordsToFilesResponse> - Promise resolving to the response

  • Export records from a table to files. All tables can be exported, in full or partial (see columns_to_export and columns_to_skip). Additional filtering can be applied when using export table with expression through SQL. Default destination is KIFS, though other storage types (Azure, S3, GCS, and HDFS) are supported through datasink_name; see create_datasink.

    Server’s local file system is not supported. Default file format is delimited text. See options for different file types and different options for each file type. Table is saved to a single file if within max file size limits (may vary depending on datasink type). If not, then table is split into multiple files; these may be smaller than the max size limit.

    All filenames created are returned in the response.

    Parameters

    Returns Promise<ExportRecordsToFilesResponse>

    Promise<Types.ExportRecordsToFilesResponse> - Promise resolving to the response