Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class CsvExportOptions.
Options for exporting data in CSV format.
Generated from protobuf message google.cloud.alloydb.v1.ExportClusterRequest.CsvExportOptions
Namespace
Google \ Cloud \ AlloyDb \ V1 \ ExportClusterRequest
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ select_query
string
Required. The SELECT query used to extract the data.
↳ field_delimiter
string
Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code.
↳ quote_character
string
Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code.
↳ escape_character
string
Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is the same as quote character. The value of this argument has to be a character in Hex ASCII Code.
getSelectQuery
Required. The SELECT query used to extract the data.
Returns
Type
Description
string
setSelectQuery
Required. The SELECT query used to extract the data.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFieldDelimiter
Optional. Specifies the character that separates columns within each row
(line) of the file. The default is comma. The value of this argument has
to be a character in Hex ASCII Code.
Returns
Type
Description
string
setFieldDelimiter
Optional. Specifies the character that separates columns within each row
(line) of the file. The default is comma. The value of this argument has
to be a character in Hex ASCII Code.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getQuoteCharacter
Optional. Specifies the quoting character to be used when a data value is
quoted. The default is double-quote. The value of this argument has to be
a character in Hex ASCII Code.
Returns
Type
Description
string
setQuoteCharacter
Optional. Specifies the quoting character to be used when a data value is
quoted. The default is double-quote. The value of this argument has to be
a character in Hex ASCII Code.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEscapeCharacter
Optional. Specifies the character that should appear before a data
character that needs to be escaped. The default is the same as quote
character. The value of this argument has to be a character in Hex ASCII
Code.
Returns
Type
Description
string
setEscapeCharacter
Optional. Specifies the character that should appear before a data
character that needs to be escaped. The default is the same as quote
character. The value of this argument has to be a character in Hex ASCII
Code.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud AlloyDB for PostgreSQL V1 Client - Class CsvExportOptions (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-alloydb/latest/V1.ExportClusterRequest.CsvExportOptions)\n- [1.4.0](/php/docs/reference/cloud-alloydb/1.4.0/V1.ExportClusterRequest.CsvExportOptions)\n- [1.3.0](/php/docs/reference/cloud-alloydb/1.3.0/V1.ExportClusterRequest.CsvExportOptions)\n- [1.2.0](/php/docs/reference/cloud-alloydb/1.2.0/V1.ExportClusterRequest.CsvExportOptions)\n- [1.1.3](/php/docs/reference/cloud-alloydb/1.1.3/V1.ExportClusterRequest.CsvExportOptions)\n- [1.0.0](/php/docs/reference/cloud-alloydb/1.0.0/V1.ExportClusterRequest.CsvExportOptions)\n- [0.10.3](/php/docs/reference/cloud-alloydb/0.10.3/V1.ExportClusterRequest.CsvExportOptions)\n- [0.9.0](/php/docs/reference/cloud-alloydb/0.9.0/V1.ExportClusterRequest.CsvExportOptions)\n- [0.8.0](/php/docs/reference/cloud-alloydb/0.8.0/V1.ExportClusterRequest.CsvExportOptions)\n- [0.7.1](/php/docs/reference/cloud-alloydb/0.7.1/V1.ExportClusterRequest.CsvExportOptions)\n- [0.6.0](/php/docs/reference/cloud-alloydb/0.6.0/V1.ExportClusterRequest.CsvExportOptions)\n- [0.5.0](/php/docs/reference/cloud-alloydb/0.5.0/V1.ExportClusterRequest.CsvExportOptions)\n- [0.4.0](/php/docs/reference/cloud-alloydb/0.4.0/V1.ExportClusterRequest.CsvExportOptions)\n- [0.3.0](/php/docs/reference/cloud-alloydb/0.3.0/V1.ExportClusterRequest.CsvExportOptions)\n- [0.2.1](/php/docs/reference/cloud-alloydb/0.2.1/V1.ExportClusterRequest.CsvExportOptions)\n- [0.1.3](/php/docs/reference/cloud-alloydb/0.1.3/V1.ExportClusterRequest.CsvExportOptions) \nReference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class CsvExportOptions.\n\nOptions for exporting data in CSV format.\n\nGenerated from protobuf message `google.cloud.alloydb.v1.ExportClusterRequest.CsvExportOptions`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AlloyDb \\\\ V1 \\\\ ExportClusterRequest\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSelectQuery\n\nRequired. The SELECT query used to extract the data.\n\n### setSelectQuery\n\nRequired. The SELECT query used to extract the data.\n\n### getFieldDelimiter\n\nOptional. Specifies the character that separates columns within each row\n(line) of the file. The default is comma. The value of this argument has\nto be a character in Hex ASCII Code.\n\n### setFieldDelimiter\n\nOptional. Specifies the character that separates columns within each row\n(line) of the file. The default is comma. The value of this argument has\nto be a character in Hex ASCII Code.\n\n### getQuoteCharacter\n\nOptional. Specifies the quoting character to be used when a data value is\nquoted. The default is double-quote. The value of this argument has to be\na character in Hex ASCII Code.\n\n### setQuoteCharacter\n\nOptional. Specifies the quoting character to be used when a data value is\nquoted. The default is double-quote. The value of this argument has to be\na character in Hex ASCII Code.\n\n### getEscapeCharacter\n\nOptional. Specifies the character that should appear before a data\ncharacter that needs to be escaped. The default is the same as quote\ncharacter. The value of this argument has to be a character in Hex ASCII\nCode.\n\n### setEscapeCharacter\n\nOptional. Specifies the character that should appear before a data\ncharacter that needs to be escaped. The default is the same as quote\ncharacter. The value of this argument has to be a character in Hex ASCII\nCode."]]
