DescribeStatementResponse

import type { DescribeStatementResponse } from "https://aws-api.deno.dev/v0.3/services/redshiftdata.ts?docs=full";

interface DescribeStatementResponse {

ClusterIdentifier?: string | null;

CreatedAt?: Date | number | null;

Database?: string | null;

DbUser?: string | null;

Duration?: number | null;

Error?: string | null;

HasResultSet?: boolean | null;

Id: string;

QueryParameters?: SqlParameter[] | null;

QueryString?: string | null;

RedshiftPid?: number | null;

RedshiftQueryId?: number | null;

ResultRows?: number | null;

ResultSize?: number | null;

SecretArn?: string | null;

Status?: StatusString | null;

SubStatements?: SubStatementData[] | null;

UpdatedAt?: Date | number | null;

}

§Properties

ClusterIdentifier?: string | null

[src]

The cluster identifier.

CreatedAt?: Date | number | null

[src]

The date and time (UTC) when the SQL statement was submitted to run.

Database?: string | null

[src]

The name of the database.

DbUser?: string | null

[src]

The database user name.

Duration?: number | null

[src]

The amount of time in nanoseconds that the statement ran.

Error?: string | null

[src]

The error message from the cluster if the SQL statement encountered an error while running.

HasResultSet?: boolean | null

[src]

A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.

Id: string

[src]

The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

QueryParameters?: SqlParameter[] | null

[src]

The parameters for the SQL statement.

QueryString?: string | null

[src]

The SQL statement text.

RedshiftPid?: number | null

[src]

The process identifier from Amazon Redshift.

RedshiftQueryId?: number | null

[src]

The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

ResultRows?: number | null

[src]

Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.

ResultSize?: number | null

[src]

The size in bytes of the returned results. A -1 indicates the value is null.

SecretArn?: string | null

[src]

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

Status?: StatusString | null

[src]

The status of the SQL statement being described. Status values are defined as follows:

ABORTED - The query run was stopped by the user.
ALL - A status value that includes all query statuses. This value can be used to filter results.
FAILED - The query run failed.
FINISHED - The query has finished running.
PICKED - The query has been chosen to be run.
STARTED - The query run has started.
SUBMITTED - The query was submitted, but not yet processed.

SubStatements?: SubStatementData[] | null

[src]

The SQL statements from a multiple statement run.

UpdatedAt?: Date | number | null

[src]

The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.