RDS data (Relational Database Service Data)

Implementation details for API rds-data

Coverage Overview

Relational Database Service Data (RDS data) is supported by LocalStack only in the pro image.

AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
BatchExecuteStatement✔️pro✔️✔️✔️Show Tests
BeginTransaction✔️pro✔️✔️✔️Show Tests
CommitTransaction✔️pro✔️✔️✔️Show Tests
ExecuteSql✔️pro✔️✔️✔️Show Tests
ExecuteStatement✔️pro✔️✔️✔️Show Tests
RollbackTransaction✔️pro✔️✔️✔️Show Tests

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the exeuction of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


BatchExecuteStatement

Parameters: database, parameterSets, resourceArn, secretArn, sql
  • LocalStack Pro
    • test_batch_execute_statement_inserts[mysql-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_inserts[mysql-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_inserts[postgres-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_inserts[postgres-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_inserts[postgres-v2] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_inserts[postgres-v2] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_validate_atomicity[postgres-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_validate_atomicity[postgres-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_validate_atomicity[postgres-v2] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_validate_atomicity[postgres-v2] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_validate_atomicity[mysql-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_validate_atomicity[mysql-v1] HTTP Status Code: 400 (BadRequestException) AWS validated Snapshot Tested

BeginTransaction

Parameters: database, resourceArn, secretArn
  • LocalStack Pro
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested

CommitTransaction

Parameters: resourceArn, secretArn, transactionId
  • LocalStack Pro
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested

ExecuteSql

Parameters: awsSecretStoreArn, dbClusterOrInstanceArn, sqlStatements
  • LocalStack Pro
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested

ExecuteStatement

Parameters: database, formatRecordsAs, includeResultMetadata, resourceArn, secretArn, sql
  • LocalStack Pro
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: database, includeResultMetadata, parameters, resourceArn, secretArn, sql
  • LocalStack Pro
    • test_rds_data_source LocalStack Pro: tests/aws/services/appsync/test_appsync.py::TestAppSync::test_rds_data_source HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_rds_data_source_rds_utils LocalStack Pro: tests/aws/services/appsync/test_appsync.py::TestAppSync::test_rds_data_source_rds_utils HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_drop[mysql-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_drop[mysql-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_drop[postgres-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_drop[postgres-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_drop[postgres-v2] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_drop[postgres-v2] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_inserts[mysql-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_inserts[mysql-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_inserts[postgres-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_inserts[postgres-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_inserts[postgres-v2] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_inserts[postgres-v2] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_setup[mysql-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_setup[mysql-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_setup[postgres-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_setup[postgres-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_statement_setup[postgres-v2] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_statement_setup[postgres-v2] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_validate_atomicity[mysql-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_validate_atomicity[mysql-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_validate_atomicity[postgres-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_validate_atomicity[postgres-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_batch_execute_validate_atomicity[postgres-v2] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_batch_execute_validate_atomicity[postgres-v2] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_column_metadata_for_mysql[mysql-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_column_metadata_for_mysql[mysql-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_column_metadata_for_postgres[postgres-v1] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_column_metadata_for_postgres[postgres-v1] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_column_metadata_for_postgres[postgres-v2] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMultiEngine::test_column_metadata_for_postgres[postgres-v2] HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: database, includeResultMetadata, resourceArn, secretArn, sql
  • LocalStack Pro
    • test_data_api[False] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMysql::test_data_api[False] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_data_api[True] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMysql::test_data_api[True] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_select_char LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgresCfn::test_select_char HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: database, parameters, resourceArn, secretArn, sql
  • LocalStack Pro
    • test_data_api[False] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMysql::test_data_api[False] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_data_api[True] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMysql::test_data_api[True] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: database, parameters, resourceArn, secretArn, sql, transactionId
  • LocalStack Pro
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: database, resourceArn, secretArn, sql
  • LocalStack Pro
    • test_rds_data_source LocalStack Pro: tests/aws/services/appsync/test_appsync.py::TestAppSync::test_rds_data_source HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_rds_data_source_rds_utils LocalStack Pro: tests/aws/services/appsync/test_appsync.py::TestAppSync::test_rds_data_source_rds_utils HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_data_api[False] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMysql::test_data_api[False] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_data_api[True] LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraMysql::test_data_api[True] HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 400 (BadRequestException) AWS validated Snapshot Tested
Parameters: database, resourceArn, secretArn, sql, transactionId
  • LocalStack Pro
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: includeResultMetadata, resourceArn, secretArn, sql
  • LocalStack Pro
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested
Parameters: resourceArn, secretArn, sql
  • LocalStack Pro
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested

RollbackTransaction

Parameters: resourceArn, secretArn, transactionId
  • LocalStack Pro
    • test_data_api LocalStack Pro: tests/aws/services/rds/test_rds_data.py::TestAuroraPostgres::test_data_api HTTP Status Code: 200 AWS validated Snapshot Tested


Last modified March 20, 2023: improve Coverage Docs (#505) (46f2fb0c0)