ExecuteSqlPayload(mapping=None, *, ignore_unknown_fields=False, **kwargs)The request payload used to execute SQL statements.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes |
|
|---|---|
| Name | Description |
user |
str
Optional. The name of an existing database user to connect to the database. When auto_iam_authn is set to true,
this field is ignored and the API caller's IAM user is used.
|
sql_statement |
str
Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons. |
database |
str
Optional. Name of the database on which the statement will be executed. |
password_secret_version |
str
Optional. The resource name of the Secret Manager secret holding the password for the user to log into the database. The secret should be created using the regional endpoint (for API) or from the Regional Secrets page (for UI), and stored in the same region as the Cloud SQL instance. The expected resource name format is projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version}.
This field is used together with the user field. The
secret resource name will not be stored.
This field is a member of oneof_ user_password.
|
auto_iam_authn |
bool
Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database. This field is a member of oneof_ user_password.
|
row_limit |
int
Optional. The maximum number of rows returned per SQL statement. |
partial_result_mode |
google.cloud.sqladmin_v1beta4.types.ExecuteSqlPayload.PartialResultMode
Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error. |
application |
str
Optional. Specifies the name of the application that is making the request. This field is used for telemetry. Only alphanumeric characters, dashes, and underscores are allowed. The maximum length is 32 characters. |
Classes
PartialResultMode
PartialResultMode(value)Controls how the API should respond when the SQL execution result exceeds 10 MB.