Google Cloud AlloyDB for PostgreSQL V1 Client - Class CsvExportOptions (1.3.0)

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.

Parameter
Name Description
var string
Returns
Type Description
$this