batchExecuteStatement method

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.
• Temporary credentials - when connecting to your data warehouse, choose one of the following options:
  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.
  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.
  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

May throw ActiveSessionsExceededException. May throw ActiveStatementsExceededException. May throw BatchExecuteStatementException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ValidationException.

Parameter sqls : One or more SQL statements to run. The SQL statements run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. By default, the SQL statements are run as a single transaction. If any SQL statement fails, all work is rolled back. To change this behavior, see the ExecutionMode parameter.

Parameter clientToken : A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Parameter clusterIdentifier : The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

Parameter database : The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

Parameter dbUser : The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

Parameter executionMode : Determines how the SQL statements in the batch are run. If set to TRANSACTION (the default), all SQL statements are run as a single transaction and they are committed or rolled back together. If set to AUTO_COMMIT, each SQL statement is committed individually, and a failure of one statement does not affect the others.

Parameter parameters : The parameters for the SQL statements. The parameters are available to all SQL statements in the batch. Each statement can reference any subset of the provided parameters. Each provided parameter must be referenced by at least one SQL statement in the batch.

Parameter resultFormat : The data format of the result of the SQL statement. If no format is specified, the default is JSON.

Parameter secretArn : The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

Parameter sessionId : The session identifier of the query.

Parameter sessionKeepAliveSeconds : The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

Parameter statementName : The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

Parameter waitTimeSeconds : The number of seconds to wait for all SQL statements in the batch to complete execution before returning the response. If the SQL statements do not complete within the specified time, the response returns the current status. The maximum value is 30 seconds.

Parameter withEvent : A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

Parameter workgroupName : The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

Future<BatchExecuteStatementOutput> batchExecuteStatement({
  required List<String> sqls,
  String? clientToken,
  String? clusterIdentifier,
  String? database,
  String? dbUser,
  ExecutionMode? executionMode,
  List<SqlParameter>? parameters,
  ResultFormatString? resultFormat,
  String? secretArn,
  String? sessionId,
  int? sessionKeepAliveSeconds,
  String? statementName,
  int? waitTimeSeconds,
  bool? withEvent,
  String? workgroupName,
}) async {
  _s.validateNumRange(
    'sessionKeepAliveSeconds',
    sessionKeepAliveSeconds,
    0,
    86400,
  );
  _s.validateNumRange(
    'waitTimeSeconds',
    waitTimeSeconds,
    1,
    30,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'RedshiftData.BatchExecuteStatement'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Sqls': sqls,
      'ClientToken': clientToken ?? _s.generateIdempotencyToken(),
      if (clusterIdentifier != null) 'ClusterIdentifier': clusterIdentifier,
      if (database != null) 'Database': database,
      if (dbUser != null) 'DbUser': dbUser,
      if (executionMode != null) 'ExecutionMode': executionMode.value,
      if (parameters != null) 'Parameters': parameters,
      if (resultFormat != null) 'ResultFormat': resultFormat.value,
      if (secretArn != null) 'SecretArn': secretArn,
      if (sessionId != null) 'SessionId': sessionId,
      if (sessionKeepAliveSeconds != null)
        'SessionKeepAliveSeconds': sessionKeepAliveSeconds,
      if (statementName != null) 'StatementName': statementName,
      if (waitTimeSeconds != null) 'WaitTimeSeconds': waitTimeSeconds,
      if (withEvent != null) 'WithEvent': withEvent,
      if (workgroupName != null) 'WorkgroupName': workgroupName,
    },
  );

  return BatchExecuteStatementOutput.fromJson(jsonResponse.body);
}