Console
    Contact Us Start free

    Google Cloud Sql Admin V1 Client - Class ExportContext (0.3.1)

    Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class ExportContext.

    Database instance export context.

    Generated from protobuf message google.cloud.sql.v1.ExportContext

    Namespace

    Google \ Cloud \ Sql \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ uri
    string

    The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the request succeeds, but the operation fails. If fileTypeis SQLand the filename ends with .gz, the contents are compressed.

    ↳ databases
    array

    Databases to be exported. * MySQL instances:If fileTypeis SQLand no database is specified, all databases are exported, except for the mysqlsystem database. If fileTypeis CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQueryproperty, which takes precedence over this property. * PostgreSQL instances:You must specify one database to be exported. If fileTypeis CSV, this database must match the one specified in the csvExportOptions.selectQueryproperty. * SQL Server instances:You must specify one database to be exported, and the fileTypemust be BAK.

    ↳ kind
    string

    This is always sql#exportContext.

    ↳ sql_export_options
    Google\Cloud\Sql\V1\ExportContext\SqlExportOptions

    Options for exporting data as SQL statements.

    ↳ csv_export_options
    Google\Cloud\Sql\V1\ExportContext\SqlCsvExportOptions

    Options for exporting data as CSV. MySQLand PostgreSQLinstances only.

    ↳ file_type
    int

    The file type for the specified uri. * SQL: The file contains SQL statements. * CSV: The file contains CSV data. * BAK: The file contains backup data for a SQL Server instance.

    ↳ offload
    Google\Protobuf\BoolValue

    Option for export offload.

    getUri

    The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the request succeeds, but the operation fails. If fileTypeis SQLand the filename ends with .gz, the contents are compressed.

    Returns
    Type
    Description
    string

    setUri

    The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the request succeeds, but the operation fails. If fileTypeis SQLand the filename ends with .gz, the contents are compressed.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDatabases

    Databases to be exported.

    • MySQL instances:If fileTypeis SQLand no database is specified, all databases are exported, except for the mysqlsystem database. If fileTypeis CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQueryproperty, which takes precedence over this property.
    • PostgreSQL instances:You must specify one database to be exported. If fileTypeis CSV, this database must match the one specified in the csvExportOptions.selectQueryproperty.
    • SQL Server instances:You must specify one database to be exported, and the fileTypemust be BAK.
    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setDatabases

    Databases to be exported.

    • MySQL instances:If fileTypeis SQLand no database is specified, all databases are exported, except for the mysqlsystem database. If fileTypeis CSV, you can specify one database, either by using this property or by using the csvExportOptions.selectQueryproperty, which takes precedence over this property.
    • PostgreSQL instances:You must specify one database to be exported. If fileTypeis CSV, this database must match the one specified in the csvExportOptions.selectQueryproperty.
    • SQL Server instances:You must specify one database to be exported, and the fileTypemust be BAK.
    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getKind

    This is always sql#exportContext.

    Returns
    Type
    Description
    string

    setKind

    This is always sql#exportContext.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSqlExportOptions

    Options for exporting data as SQL statements.

    Returns
    Type
    Description
    Google\Cloud\Sql\V1\ExportContext\SqlExportOptions |null

    hasSqlExportOptions

    clearSqlExportOptions

    setSqlExportOptions

    Options for exporting data as SQL statements.

    Parameter
    Name
    Description
    var
    Google\Cloud\Sql\V1\ExportContext\SqlExportOptions
    Returns
    Type
    Description
    $this

    getCsvExportOptions

    Options for exporting data as CSV. MySQLand PostgreSQLinstances only.

    Returns
    Type
    Description
    Google\Cloud\Sql\V1\ExportContext\SqlCsvExportOptions |null

    hasCsvExportOptions

    clearCsvExportOptions

    setCsvExportOptions

    Options for exporting data as CSV. MySQLand PostgreSQLinstances only.

    Parameter
    Name
    Description
    var
    Google\Cloud\Sql\V1\ExportContext\SqlCsvExportOptions
    Returns
    Type
    Description
    $this

    getFileType

    The file type for the specified uri.

    • SQL: The file contains SQL statements.
    • CSV: The file contains CSV data.
    • BAK: The file contains backup data for a SQL Server instance.
    Returns
    Type
    Description
    int

    setFileType

    The file type for the specified uri.

    • SQL: The file contains SQL statements.
    • CSV: The file contains CSV data.
    • BAK: The file contains backup data for a SQL Server instance.
    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getOffload

    Option for export offload.

    Returns
    Type
    Description
    Google\Protobuf\BoolValue |null

    hasOffload

    clearOffload

    getOffloadValue

    Returns the unboxed value from getOffload()

    Option for export offload.

    Returns
    Type
    Description
    bool|null

    setOffload

    Option for export offload.

    Parameter
    Name
    Description
    var
    Google\Protobuf\BoolValue
    Returns
    Type
    Description
    $this

    setOffloadValue

    Sets the field by wrapping a primitive type in a Google\Protobuf\BoolValue object.

    Option for export offload.

    Parameter
    Name
    Description
    var
    bool|null
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: