executeSql method

  1. @Deprecated('Deprecated')
Future<ExecuteSqlResponse> executeSql({
  1. required String awsSecretStoreArn,
  2. required String dbClusterOrInstanceArn,
  3. required String sqlStatements,
  4. String? database,
  5. String? schema,
})

Runs one or more SQL statements.

May throw BadRequestException. May throw InternalServerErrorException. May throw ForbiddenException. May throw ServiceUnavailableError.

Parameter awsSecretStoreArn : The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.

Parameter dbClusterOrInstanceArn : The ARN of the Aurora Serverless DB cluster.

Parameter sqlStatements : One or more SQL statements to run on the DB cluster.

You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements.

Parameter database : The name of the database.

Parameter schema : The name of the database schema.

Implementation

@Deprecated('Deprecated')
Future<ExecuteSqlResponse> executeSql({
  required String awsSecretStoreArn,
  required String dbClusterOrInstanceArn,
  required String sqlStatements,
  String? database,
  String? schema,
}) async {
  ArgumentError.checkNotNull(awsSecretStoreArn, 'awsSecretStoreArn');
  _s.validateStringLength(
    'awsSecretStoreArn',
    awsSecretStoreArn,
    11,
    100,
    isRequired: true,
  );
  ArgumentError.checkNotNull(
      dbClusterOrInstanceArn, 'dbClusterOrInstanceArn');
  _s.validateStringLength(
    'dbClusterOrInstanceArn',
    dbClusterOrInstanceArn,
    11,
    100,
    isRequired: true,
  );
  ArgumentError.checkNotNull(sqlStatements, 'sqlStatements');
  _s.validateStringLength(
    'sqlStatements',
    sqlStatements,
    0,
    65536,
    isRequired: true,
  );
  _s.validateStringLength(
    'database',
    database,
    0,
    64,
  );
  _s.validateStringLength(
    'schema',
    schema,
    0,
    64,
  );
  final $payload = <String, dynamic>{
    'awsSecretStoreArn': awsSecretStoreArn,
    'dbClusterOrInstanceArn': dbClusterOrInstanceArn,
    'sqlStatements': sqlStatements,
    if (database != null) 'database': database,
    if (schema != null) 'schema': schema,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/ExecuteSql',
    exceptionFnMap: _exceptionFns,
  );
  return ExecuteSqlResponse.fromJson(response);
}