Référence des opérations de l'API Amazon RDS Data

L'API de données Amazon RDS fournit les opérations suivantes pour exécuter des instructions SQL.

Opération d'API de données	AWS CLI commande	Description
ExecuteStatement	aws rds-data execute-statement	Exécute une instruction SQL sur une base de données.
BatchExecuteStatement	aws rds-data batch-execute-statement	Exécute une instruction SQL par lots sur un tableau de données pour les opérations d'insertion et de mise à jour en bloc. Vous pouvez exécuter une instruction en langage de manipulation de données (DML) avec un tableau de jeux de paramètres. Une instruction SQL par lots peut nettement améliorer les performances sur des instructions d'insertion et de mise à jour.

Vous pouvez utiliser l'une ou l'autre des opérations pour exécuter des instructions SQL individuelles ou des transactions. Pour les transactions, l'API Data fournit les opérations suivantes.

Opération d'API de données	AWS CLI commande	Description
BeginTransaction	aws rds-data begin-transaction	Démarre une transaction SQL.
CommitTransaction	aws rds-data commit-transaction	Termine une transaction SQL et valide les modifications.
RollbackTransaction	aws rds-data rollback-transaction	Restaure une transaction.

Les opérations permettant d'exécuter des instructions SQL et de prendre en charge les transactions ont les paramètres et AWS CLI options communs suivants de l'API de données. Certaines opérations prennent en charge d'autres paramètres et options.

Paramètre d'opération d'API de données	AWS CLI option de commande	Obligatoire	Description
resourceArn	--resource-arn	Oui	Le nom de ressource Amazon (ARN) du cluster de base de données Aurora. Le cluster doit être identique Compte AWS au rôle ou à l'utilisateur IAM qui appelle l'API de données. Pour accéder à un cluster dans un autre compte, assumez un rôle dans ce compte.
secretArn	--secret-arn	Oui	Nom ou ARN du secret qui active l'accès au cluster de bases de données.

L'API RDS Data prend en charge les types de données suivants pour Aurora MySQL :

• TINYINT(1), BOOLEAN, BOOL

• TINYINT

• SMALLINT [SIGNED | UNSIGNED]

• MEDIUMINT [SIGNED | UNSIGNED]

• INT [SIGNED | UNSIGNED]

• BIGINT [SIGNED | UNSIGNED]

• FLOAT

• DOUBLE

• VARCHAR, CHAR, TEXT, ENUM

• VARBINARY, BINARY, BLOB

• DATE, TIME, DATETIME, TIMESTAMP

• DECIMAL

• JSON

• BIT, BIT(N)

L'API RDS Data prend en charge les types scalaires Aurora PostgreSQL suivants :

• BOOL

• BYTEA

• DATE

• CIDR

• DECIMAL, NUMERIC

• ENUM

• FLOAT8, DOUBLE PRECISION

• INET

• INT, INT4, SERIAL

• INT2, SMALLINT, SMALLSERIAL

• INT8, BIGINT, BIGSERIAL

• JSONB, JSON

• REAL, FLOAT

• TEXT, CHAR(N), VARCHAR, NAME

• TIME

• TIMESTAMP

• UUID

• VECTOR

L'API RDS Data prend en charge les types de baies Aurora PostgreSQL suivants :

• BOOL[], BIT[]

• DATE[]

• DECIMAL[], NUMERIC[]

• FLOAT8[], DOUBLE PRECISION[]

• INT[], INT4[]

• INT2[]

• INT8[], BIGINT[]

• JSON[]

• REAL[], FLOAT[]

• TEXT[], CHAR(N)[], VARCHAR[], NAME[]

• TIME[]

• TIMESTAMP[]

• UUID[]

Vous pouvez utiliser des paramètres dans les appels de l'API de données vers ExecuteStatement etBatchExecuteStatement, et lorsque vous exécutez les AWS CLI commandes execute-statement etbatch-execute-statement. Pour utiliser un paramètre, spécifiez une paire nom-valeur dans le type de données SqlParameter. Vous devez spécifier la valeur avec le type de données Field. Le tableau suivant associe les types de données Java Database Connectivity (JDBC) aux types de données que vous spécifiez dans les appels d'API de données.

Type de données JDBC	Type de données API de données
INTEGER, TINYINT, SMALLINT, BIGINT	LONG (ou STRING)
FLOAT, REAL, DOUBLE	DOUBLE
DECIMAL	STRING
BOOLEAN, BIT	BOOLEAN
BLOB, BINARY, LONGVARBINARY, VARBINARY	BLOB
CLOB	STRING
Autres types (y compris les types liés à la date et à l'heure)	STRING

Note

Vous pouvez spécifier le type de données LONG ou STRING dans votre appel d'API de données pour les valeurs LONG renvoyées par la base de données. Nous vous recommandons de le faire afin d'éviter de perdre en précision pour des nombres extrêmement élevés, ce qui peut se produire lorsque vous travaillez avec JavaScript.

Certains types, tels que DECIMAL etTIME, nécessitent un indice pour que l'API de données transmette String les valeurs à la base de données sous le type correct. Pour utiliser un indice, incluez des valeurs pour typeHint dans le type de données SqlParameter. Les valeurs possibles pour typeHint sont les suivantes :

• DATE – La valeur de paramètre String correspondante est envoyée en tant qu'objet de type DATE à la base de données. Le format accepté est YYYY-MM-DD.

• DECIMAL – La valeur de paramètre String correspondante est envoyée en tant qu'objet de type DECIMAL à la base de données.

• JSON – La valeur de paramètre String correspondante est envoyée en tant qu'objet de type JSON à la base de données.

• TIME – La valeur de paramètre String correspondante est envoyée en tant qu'objet de type TIME à la base de données. Le format accepté est HH:MM:SS[.FFF].

• TIMESTAMP – La valeur de paramètre String correspondante est envoyée en tant qu'objet de type TIMESTAMP à la base de données. Le format accepté est YYYY-MM-DD HH:MM:SS[.FFF].

• UUID – La valeur de paramètre String correspondante est envoyée en tant qu'objet de type UUID à la base de données.

  Note

  Actuellement, l'API de données ne prend pas en charge les tableaux d'identifiants uniques universels ()UUIDs.

Note

Pour Amazon Aurora PostgreSQL, l'API Data renvoie toujours le type de données Aurora PostgreSQL dans le fuseau horaire UTC. TIMESTAMPTZ