BigQuery Client - Class ExtractJobConfiguration (1.25.1)

Reference documentation and code samples for the BigQuery Client class ExtractJobConfiguration.

Represents a configuration for an extract job. For more information on the available settings please see the Jobs configuration API documentation.

Example:

use Google\Cloud\BigQuery\BigQueryClient;

$bigQuery = new BigQueryClient();
$table = $bigQuery->dataset('my_dataset')
    ->table('my_table');
$extractJobConfig = $table->extract('gs://my_bucket/target.csv');

Sets the compression type to use for exported files.

Not applicable when extracting models.

Example:

$extractJobConfig->compression('GZIP');

Sets the exported file format. Tables with nested or repeated fields cannot be exported as CSV.

Example:

$extractJobConfig->destinationFormat('NEWLINE_DELIMITED_JSON');

Sets a list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

Example:

$extractJobConfig->destinationUris([
    'gs://my_bucket/destination.csv'
]);

Sets the delimiter to use between fields in the exported data.

Not applicable when extracting models.

Example:

$extractJobConfig->fieldDelimiter(',');

Sets whether or not to print out a header row in the results.

Not applicable when extracting models.

Example:

$extractJobConfig->printHeader(false);

Sets a reference to the table being exported.

Cannot be used in the same job as Google\Cloud\BigQuery\ExtractJobConfiguration::sourceModel().

Example:

$table = $bigQuery->dataset('my_dataset')
    ->table('my_table');
$extractJobConfig->sourceTable($table);

Sets a reference to the model being exported.

Cannot be used in the same job as Google\Cloud\BigQuery\ExtractJobConfiguration::sourceTable().

Example:

$model = $bigQuery->dataset('my_dataset')
    ->model('my_model');
$extractJobConfig->sourceModel($model);

Sets whether to use logical types when extracting to AVRO format.

If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long).

Not applicable when extracting models.

Example:

$extractJobConfig->useAvroLogicalTypes(true);