Skip to content

Update a Hyperscale Dataset table or file by ID.

Request

Security
ApiKeyAuth
Path
hyperscaleDatasetIdstring, non-emptyrequired

The ID of the Hyperscale Dataset.

hyperscaleDatasetTableOrFileIdstring, non-emptyrequired

The ID of the Hyperscale Dataset table or file.

Bodyapplication/json

The new data to update a Hyperscale Dataset table or file.

filter_keystring

The unique database column field to filter the source data. Set this property to an empty string to clear the value.

column_array_rowsinteger, (int64)

The number of column array rows to be used by the sqlldr oracle utility which determines the number of rows loaded before the stream buffer is built.

unload_splitinteger, (int64)

The number of unloaded files to be generated from the source database.

stream_sizeinteger, (int64)

Long The stream size to be used by the sqlldr oracle utility which specifies the size (in bytes) of the data stream sent from the client to the server.

end_of_recordstring

The end of line character. Support values are \n, \r and \r\n (Delimited files only).

delimiterstring

The single character length delimiter used in source files (Delimited files only).

enclosurestring

The single character length quote character used in the source files (Delimited files only).

enclosure_escape_characterstring

The escape character used to escape quote characters (Delimited files only).

escape_enclosure_escape_characterboolean

Whether to escape the enclosure escape character (Delimited files only).

has_headersboolean

Whether source files have header column names or not (Delimited files only). If set to true, format files with the same column names are created and the same can be used for the masking inventory. If set to false, the column names of pattern f0, f1, f2, and so on are used to create the format files for delimited file masking.

unique_source_files_identifierstring

This is the source key that maps the load-service and masking-service data sets with the unload-service data set (Delimited files only). Please ensure that this value is different for each HyperscaleDatasetTableOrFile.

source_filesArray of strings

List of all source files that need to be masked (Delimited files only). All files should have the same delimiter character and other helper characters. All files should have the same number of columns and same column names if it has a header line.

perform_joinboolean

Whether the split files must be joined (Delimited files only).

curl -i -X PATCH \
  'https://help-api.delphix.com/_mock/data-control-tower/continuous-compliance/2025.4.0.0/continuous-compliance-apis-dct-2025.4.0.0/hyperscale-datasets/{hyperscaleDatasetId}/tables-or-files/{hyperscaleDatasetTableOrFileId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "filter_key": "string",
    "column_array_rows": 0,
    "unload_split": 0,
    "stream_size": 0,
    "end_of_record": "string",
    "delimiter": "string",
    "enclosure": "string",
    "enclosure_escape_character": "string",
    "escape_enclosure_escape_character": true,
    "has_headers": true,
    "unique_source_files_identifier": "string",
    "source_files": [
      "string"
    ],
    "perform_join": true
  }'

Responses

OK

Bodyapplication/json
jobobject(Job)

An asynchronous task.

Response
{ "job": { "id": "job-123", "status": "RUNNING", "is_waiting_for_telemetry": true, "type": "DB_REFRESH", "localized_type": "DB Refresh", "error_details": "Unable to connect to the engine.", "warning_message": "Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.", "target_id": "vdb-123", "target_name": "vdb", "start_time": "2022-01-02T05:11:24.148000+00:00", "update_time": "2022-01-02T06:11:24.148000+00:00", "trace_id": "string", "engine_ids": [ … ], "tags": [ … ], "engines": [ … ], "account_id": 1, "account_name": "User 1", "percent_complete": "50", "virtualization_tasks": [ … ], "tasks": [ … ], "execution_id": "string", "result_type": "string", "result": {} } }