Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class ExecuteSqlPayload.
The request payload used to execute SQL statements.
Generated from protobuf message google.cloud.sql.v1.ExecuteSqlPayload
Namespace
Google \ Cloud \ Sql \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ user
string
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
string
Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.
↳ database
string
Optional. Name of the database on which the statement will be executed.
↳ 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.
↳ row_limit
int|string
Optional. The maximum number of rows returned per SQL statement.
↳ partial_result_mode
int
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.
getUser
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.
string
setUser
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.
var
string
$this
getSqlStatement
Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.
string
setSqlStatement
Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.
var
string
$this
getDatabase
Optional. Name of the database on which the statement will be executed.
string
setDatabase
Optional. Name of the database on which the statement will be executed.
var
string
$this
getAutoIamAuthn
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.
bool
hasAutoIamAuthn
setAutoIamAuthn
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.
var
bool
$this
getRowLimit
Optional. The maximum number of rows returned per SQL statement.
int|string
setRowLimit
Optional. The maximum number of rows returned per SQL statement.
var
int|string
$this
getPartialResultMode
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.
setPartialResultMode
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.
$this
getUserPassword
string
