ExecuteSqlPayload

import type { ExecuteSqlPayload } from "https://googleapis.deno.dev/v1/sqladmin:v1.ts";

The request payload used to execute SQL statements.

interface ExecuteSqlPayload {

autoIamAuthn?: boolean;

database?: string;

partialResultMode?: "PARTIAL_RESULT_MODE_UNSPECIFIED" | "FAIL_PARTIAL_RESULT" | "ALLOW_PARTIAL_RESULT";

rowLimit?: bigint;

sqlStatement?: string;

user?: string;

}

§Properties

autoIamAuthn?: boolean

[src]

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.

database?: string

[src]

Optional. Name of the database on which the statement will be executed.

partialResultMode?: "PARTIAL_RESULT_MODE_UNSPECIFIED" | "FAIL_PARTIAL_RESULT" | "ALLOW_PARTIAL_RESULT"

[src]

Optional. Controls how the API should respond when the SQL execution result exceeds 10 MB. The default mode is to throw an error.

rowLimit?: bigint

[src]

Optional. The maximum number of rows returned per SQL statement.

sqlStatement?: string

[src]

Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons.

user?: string

[src]

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.