aws-sdk-rdsdataservice 1.34.0 → 1.37.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rdsdataservice/client.rb +239 -165
- data/lib/aws-sdk-rdsdataservice/client_api.rb +66 -50
- data/lib/aws-sdk-rdsdataservice/errors.rb +20 -4
- data/lib/aws-sdk-rdsdataservice/types.rb +367 -265
- data/lib/aws-sdk-rdsdataservice.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b30fef0b07054f5ff92d546ebbf9dfef1c85821e9bb1c027729aec874574b81b
|
4
|
+
data.tar.gz: 6abb77d02b89a0f280198108f2b12360db19886d3100518373d613ff9bcdb85a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e58c9a4a52db9b1c7b0e663e47365561319ebb55e12cf7d4cfed86108bf7c94cf76ebb97aa3490fc8bed180ad7361622596053319be2dddf30dea3ce5d1fed60
|
7
|
+
data.tar.gz: 9811aa09a4dfca137fa047c125a640ab69f1be04f15f99071a51eac7de3ea8b341d2651d3f09ebb2c954c4c111fcb3b1b5ea14210f69c65ccfca029e041dcaca
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.37.0 (2022-08-31)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation updates for RDS Data API
|
8
|
+
|
9
|
+
1.36.0 (2022-06-24)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Documentation updates for RDS Data API
|
13
|
+
|
14
|
+
1.35.0 (2022-04-25)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Support to receive SQL query results in the form of a simplified JSON string. This enables developers using the new JSON string format to more easily convert it to an object using popular JSON string parsing libraries.
|
18
|
+
|
4
19
|
1.34.0 (2022-02-24)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.37.0
|
@@ -358,13 +358,48 @@ module Aws::RDSDataService
|
|
358
358
|
# can provide a significant performance improvement over individual
|
359
359
|
# insert and update operations.
|
360
360
|
#
|
361
|
-
# If a call isn't part of a transaction because it doesn't include the
|
361
|
+
# <note markdown="1"> If a call isn't part of a transaction because it doesn't include the
|
362
362
|
# `transactionID` parameter, changes that result from the call are
|
363
363
|
# committed automatically.
|
364
364
|
#
|
365
|
+
# There isn't a fixed upper limit on the number of parameter sets.
|
366
|
+
# However, the maximum size of the HTTP request submitted through the
|
367
|
+
# Data API is 4 MiB. If the request exceeds this limit, the Data API
|
368
|
+
# returns an error and doesn't process the request. This 4-MiB limit
|
369
|
+
# includes the size of the HTTP headers and the JSON notation in the
|
370
|
+
# request. Thus, the number of parameter sets that you can include
|
371
|
+
# depends on a combination of factors, such as the size of the SQL
|
372
|
+
# statement and the size of each parameter set.
|
373
|
+
#
|
374
|
+
# The response size limit is 1 MiB. If the call returns more than 1 MiB
|
375
|
+
# of response data, the call is terminated.
|
376
|
+
#
|
377
|
+
# </note>
|
378
|
+
#
|
379
|
+
# @option params [required, String] :resource_arn
|
380
|
+
# The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
381
|
+
#
|
382
|
+
# @option params [required, String] :secret_arn
|
383
|
+
# The ARN of the secret that enables access to the DB cluster. Enter the
|
384
|
+
# database user name and password for the credentials in the secret.
|
385
|
+
#
|
386
|
+
# For information about creating the secret, see [Create a database
|
387
|
+
# secret][1].
|
388
|
+
#
|
389
|
+
#
|
390
|
+
#
|
391
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
|
392
|
+
#
|
393
|
+
# @option params [required, String] :sql
|
394
|
+
# The SQL statement to run. Don't include a semicolon (;) at the end of
|
395
|
+
# the SQL statement.
|
396
|
+
#
|
365
397
|
# @option params [String] :database
|
366
398
|
# The name of the database.
|
367
399
|
#
|
400
|
+
# @option params [String] :schema
|
401
|
+
# The name of the database schema.
|
402
|
+
#
|
368
403
|
# @option params [Array<Array>] :parameter_sets
|
369
404
|
# The parameter set for the batch operation.
|
370
405
|
#
|
@@ -381,18 +416,6 @@ module Aws::RDSDataService
|
|
381
416
|
#
|
382
417
|
# </note>
|
383
418
|
#
|
384
|
-
# @option params [required, String] :resource_arn
|
385
|
-
# The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
386
|
-
#
|
387
|
-
# @option params [String] :schema
|
388
|
-
# The name of the database schema.
|
389
|
-
#
|
390
|
-
# @option params [required, String] :secret_arn
|
391
|
-
# The name or ARN of the secret that enables access to the DB cluster.
|
392
|
-
#
|
393
|
-
# @option params [required, String] :sql
|
394
|
-
# The SQL statement to run.
|
395
|
-
#
|
396
419
|
# @option params [String] :transaction_id
|
397
420
|
# The identifier of a transaction that was started by using the
|
398
421
|
# `BeginTransaction` operation. Specify the transaction ID of the
|
@@ -408,38 +431,38 @@ module Aws::RDSDataService
|
|
408
431
|
# @example Request syntax with placeholder values
|
409
432
|
#
|
410
433
|
# resp = client.batch_execute_statement({
|
434
|
+
# resource_arn: "Arn", # required
|
435
|
+
# secret_arn: "Arn", # required
|
436
|
+
# sql: "SqlStatement", # required
|
411
437
|
# database: "DbName",
|
438
|
+
# schema: "DbName",
|
412
439
|
# parameter_sets: [
|
413
440
|
# [
|
414
441
|
# {
|
415
442
|
# name: "ParameterName",
|
416
|
-
# type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
|
417
443
|
# value: {
|
444
|
+
# is_null: false,
|
445
|
+
# boolean_value: false,
|
446
|
+
# long_value: 1,
|
447
|
+
# double_value: 1.0,
|
448
|
+
# string_value: "String",
|
449
|
+
# blob_value: "data",
|
418
450
|
# array_value: {
|
451
|
+
# boolean_values: [false],
|
452
|
+
# long_values: [1],
|
453
|
+
# double_values: [1.0],
|
454
|
+
# string_values: ["String"],
|
419
455
|
# array_values: [
|
420
456
|
# {
|
421
457
|
# # recursive ArrayValue
|
422
458
|
# },
|
423
459
|
# ],
|
424
|
-
# boolean_values: [false],
|
425
|
-
# double_values: [1.0],
|
426
|
-
# long_values: [1],
|
427
|
-
# string_values: ["String"],
|
428
460
|
# },
|
429
|
-
# blob_value: "data",
|
430
|
-
# boolean_value: false,
|
431
|
-
# double_value: 1.0,
|
432
|
-
# is_null: false,
|
433
|
-
# long_value: 1,
|
434
|
-
# string_value: "String",
|
435
461
|
# },
|
462
|
+
# type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
|
436
463
|
# },
|
437
464
|
# ],
|
438
465
|
# ],
|
439
|
-
# resource_arn: "Arn", # required
|
440
|
-
# schema: "DbName",
|
441
|
-
# secret_arn: "Arn", # required
|
442
|
-
# sql: "SqlStatement", # required
|
443
466
|
# transaction_id: "Id",
|
444
467
|
# })
|
445
468
|
#
|
@@ -447,22 +470,22 @@ module Aws::RDSDataService
|
|
447
470
|
#
|
448
471
|
# resp.update_results #=> Array
|
449
472
|
# resp.update_results[0].generated_fields #=> Array
|
450
|
-
# resp.update_results[0].generated_fields[0].
|
451
|
-
# resp.update_results[0].generated_fields[0].
|
473
|
+
# resp.update_results[0].generated_fields[0].is_null #=> Boolean
|
474
|
+
# resp.update_results[0].generated_fields[0].boolean_value #=> Boolean
|
475
|
+
# resp.update_results[0].generated_fields[0].long_value #=> Integer
|
476
|
+
# resp.update_results[0].generated_fields[0].double_value #=> Float
|
477
|
+
# resp.update_results[0].generated_fields[0].string_value #=> String
|
478
|
+
# resp.update_results[0].generated_fields[0].blob_value #=> String
|
452
479
|
# resp.update_results[0].generated_fields[0].array_value.boolean_values #=> Array
|
453
480
|
# resp.update_results[0].generated_fields[0].array_value.boolean_values[0] #=> Boolean
|
454
|
-
# resp.update_results[0].generated_fields[0].array_value.double_values #=> Array
|
455
|
-
# resp.update_results[0].generated_fields[0].array_value.double_values[0] #=> Float
|
456
481
|
# resp.update_results[0].generated_fields[0].array_value.long_values #=> Array
|
457
482
|
# resp.update_results[0].generated_fields[0].array_value.long_values[0] #=> Integer
|
483
|
+
# resp.update_results[0].generated_fields[0].array_value.double_values #=> Array
|
484
|
+
# resp.update_results[0].generated_fields[0].array_value.double_values[0] #=> Float
|
458
485
|
# resp.update_results[0].generated_fields[0].array_value.string_values #=> Array
|
459
486
|
# resp.update_results[0].generated_fields[0].array_value.string_values[0] #=> String
|
460
|
-
# resp.update_results[0].generated_fields[0].
|
461
|
-
# resp.update_results[0].generated_fields[0].
|
462
|
-
# resp.update_results[0].generated_fields[0].double_value #=> Float
|
463
|
-
# resp.update_results[0].generated_fields[0].is_null #=> Boolean
|
464
|
-
# resp.update_results[0].generated_fields[0].long_value #=> Integer
|
465
|
-
# resp.update_results[0].generated_fields[0].string_value #=> String
|
487
|
+
# resp.update_results[0].generated_fields[0].array_value.array_values #=> Array
|
488
|
+
# resp.update_results[0].generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
|
466
489
|
#
|
467
490
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/BatchExecuteStatement AWS API Documentation
|
468
491
|
#
|
@@ -475,20 +498,31 @@ module Aws::RDSDataService
|
|
475
498
|
|
476
499
|
# Starts a SQL transaction.
|
477
500
|
#
|
478
|
-
#
|
501
|
+
# <note markdown="1"> A transaction can run for a maximum of 24 hours. A transaction is
|
502
|
+
# terminated and rolled back automatically after 24 hours.
|
479
503
|
#
|
480
|
-
#
|
481
|
-
#
|
504
|
+
# A transaction times out if no calls use its transaction ID in three
|
505
|
+
# minutes. If a transaction times out before it's committed, it's
|
506
|
+
# rolled back automatically.
|
507
|
+
#
|
508
|
+
# DDL statements inside a transaction cause an implicit commit. We
|
509
|
+
# recommend that you run each DDL statement in a separate
|
510
|
+
# `ExecuteStatement` call with `continueAfterTimeout` enabled.
|
511
|
+
#
|
512
|
+
# </note>
|
482
513
|
#
|
483
514
|
# @option params [required, String] :resource_arn
|
484
515
|
# The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
485
516
|
#
|
486
|
-
# @option params [String] :schema
|
487
|
-
# The name of the database schema.
|
488
|
-
#
|
489
517
|
# @option params [required, String] :secret_arn
|
490
518
|
# The name or ARN of the secret that enables access to the DB cluster.
|
491
519
|
#
|
520
|
+
# @option params [String] :database
|
521
|
+
# The name of the database.
|
522
|
+
#
|
523
|
+
# @option params [String] :schema
|
524
|
+
# The name of the database schema.
|
525
|
+
#
|
492
526
|
# @return [Types::BeginTransactionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
493
527
|
#
|
494
528
|
# * {Types::BeginTransactionResponse#transaction_id #transaction_id} => String
|
@@ -496,10 +530,10 @@ module Aws::RDSDataService
|
|
496
530
|
# @example Request syntax with placeholder values
|
497
531
|
#
|
498
532
|
# resp = client.begin_transaction({
|
499
|
-
# database: "DbName",
|
500
533
|
# resource_arn: "Arn", # required
|
501
|
-
# schema: "DbName",
|
502
534
|
# secret_arn: "Arn", # required
|
535
|
+
# database: "DbName",
|
536
|
+
# schema: "DbName",
|
503
537
|
# })
|
504
538
|
#
|
505
539
|
# @example Response structure
|
@@ -554,21 +588,25 @@ module Aws::RDSDataService
|
|
554
588
|
|
555
589
|
# Runs one or more SQL statements.
|
556
590
|
#
|
557
|
-
# This operation is deprecated. Use the `BatchExecuteStatement` or
|
591
|
+
# <note markdown="1"> This operation is deprecated. Use the `BatchExecuteStatement` or
|
558
592
|
# `ExecuteStatement` operation.
|
559
593
|
#
|
594
|
+
# </note>
|
595
|
+
#
|
596
|
+
# @option params [required, String] :db_cluster_or_instance_arn
|
597
|
+
# The ARN of the Aurora Serverless DB cluster.
|
598
|
+
#
|
560
599
|
# @option params [required, String] :aws_secret_store_arn
|
561
600
|
# The Amazon Resource Name (ARN) of the secret that enables access to
|
562
|
-
# the DB cluster.
|
601
|
+
# the DB cluster. Enter the database user name and password for the
|
602
|
+
# credentials in the secret.
|
563
603
|
#
|
564
|
-
#
|
565
|
-
#
|
604
|
+
# For information about creating the secret, see [Create a database
|
605
|
+
# secret][1].
|
566
606
|
#
|
567
|
-
# @option params [required, String] :db_cluster_or_instance_arn
|
568
|
-
# The ARN of the Aurora Serverless DB cluster.
|
569
607
|
#
|
570
|
-
#
|
571
|
-
#
|
608
|
+
#
|
609
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
|
572
610
|
#
|
573
611
|
# @option params [required, String] :sql_statements
|
574
612
|
# One or more SQL statements to run on the DB cluster.
|
@@ -577,6 +615,12 @@ module Aws::RDSDataService
|
|
577
615
|
# Any valid SQL statement is permitted, including data definition, data
|
578
616
|
# manipulation, and commit statements.
|
579
617
|
#
|
618
|
+
# @option params [String] :database
|
619
|
+
# The name of the database.
|
620
|
+
#
|
621
|
+
# @option params [String] :schema
|
622
|
+
# The name of the database schema.
|
623
|
+
#
|
580
624
|
# @return [Types::ExecuteSqlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
581
625
|
#
|
582
626
|
# * {Types::ExecuteSqlResponse#sql_statement_results #sql_statement_results} => Array<Types::SqlStatementResult>
|
@@ -584,47 +628,47 @@ module Aws::RDSDataService
|
|
584
628
|
# @example Request syntax with placeholder values
|
585
629
|
#
|
586
630
|
# resp = client.execute_sql({
|
631
|
+
# db_cluster_or_instance_arn: "Arn", # required
|
587
632
|
# aws_secret_store_arn: "Arn", # required
|
633
|
+
# sql_statements: "SqlStatement", # required
|
588
634
|
# database: "DbName",
|
589
|
-
# db_cluster_or_instance_arn: "Arn", # required
|
590
635
|
# schema: "DbName",
|
591
|
-
# sql_statements: "SqlStatement", # required
|
592
636
|
# })
|
593
637
|
#
|
594
638
|
# @example Response structure
|
595
639
|
#
|
596
640
|
# resp.sql_statement_results #=> Array
|
597
|
-
# resp.sql_statement_results[0].
|
641
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_count #=> Integer
|
642
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata #=> Array
|
643
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].name #=> String
|
644
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type #=> Integer
|
645
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type_name #=> String
|
646
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].label #=> String
|
647
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].schema_name #=> String
|
648
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].table_name #=> String
|
649
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_auto_increment #=> Boolean
|
650
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_signed #=> Boolean
|
651
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_currency #=> Boolean
|
652
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_case_sensitive #=> Boolean
|
653
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].nullable #=> Integer
|
654
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].precision #=> Integer
|
655
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].scale #=> Integer
|
656
|
+
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].array_base_column_type #=> Integer
|
598
657
|
# resp.sql_statement_results[0].result_frame.records #=> Array
|
599
658
|
# resp.sql_statement_results[0].result_frame.records[0].values #=> Array
|
600
|
-
# resp.sql_statement_results[0].result_frame.records[0].values[0].
|
601
|
-
# resp.sql_statement_results[0].result_frame.records[0].values[0].array_values[0] #=> Types::Value
|
602
|
-
# resp.sql_statement_results[0].result_frame.records[0].values[0].big_int_value #=> Integer
|
659
|
+
# resp.sql_statement_results[0].result_frame.records[0].values[0].is_null #=> Boolean
|
603
660
|
# resp.sql_statement_results[0].result_frame.records[0].values[0].bit_value #=> Boolean
|
604
|
-
# resp.sql_statement_results[0].result_frame.records[0].values[0].
|
605
|
-
# resp.sql_statement_results[0].result_frame.records[0].values[0].double_value #=> Float
|
661
|
+
# resp.sql_statement_results[0].result_frame.records[0].values[0].big_int_value #=> Integer
|
606
662
|
# resp.sql_statement_results[0].result_frame.records[0].values[0].int_value #=> Integer
|
607
|
-
# resp.sql_statement_results[0].result_frame.records[0].values[0].
|
663
|
+
# resp.sql_statement_results[0].result_frame.records[0].values[0].double_value #=> Float
|
608
664
|
# resp.sql_statement_results[0].result_frame.records[0].values[0].real_value #=> Float
|
609
665
|
# resp.sql_statement_results[0].result_frame.records[0].values[0].string_value #=> String
|
666
|
+
# resp.sql_statement_results[0].result_frame.records[0].values[0].blob_value #=> String
|
667
|
+
# resp.sql_statement_results[0].result_frame.records[0].values[0].array_values #=> Array
|
668
|
+
# resp.sql_statement_results[0].result_frame.records[0].values[0].array_values[0] #=> Types::Value
|
610
669
|
# resp.sql_statement_results[0].result_frame.records[0].values[0].struct_value.attributes #=> Array
|
611
670
|
# resp.sql_statement_results[0].result_frame.records[0].values[0].struct_value.attributes[0] #=> Types::Value
|
612
|
-
# resp.sql_statement_results[0].
|
613
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata #=> Array
|
614
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].array_base_column_type #=> Integer
|
615
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_auto_increment #=> Boolean
|
616
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_case_sensitive #=> Boolean
|
617
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_currency #=> Boolean
|
618
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].is_signed #=> Boolean
|
619
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].label #=> String
|
620
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].name #=> String
|
621
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].nullable #=> Integer
|
622
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].precision #=> Integer
|
623
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].scale #=> Integer
|
624
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].schema_name #=> String
|
625
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].table_name #=> String
|
626
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type #=> Integer
|
627
|
-
# resp.sql_statement_results[0].result_frame.result_set_metadata.column_metadata[0].type_name #=> String
|
671
|
+
# resp.sql_statement_results[0].number_of_records_updated #=> Integer
|
628
672
|
#
|
629
673
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSql AWS API Documentation
|
630
674
|
#
|
@@ -637,41 +681,34 @@ module Aws::RDSDataService
|
|
637
681
|
|
638
682
|
# Runs a SQL statement against a database.
|
639
683
|
#
|
640
|
-
# If a call isn't part of a transaction because it doesn't include the
|
684
|
+
# <note markdown="1"> If a call isn't part of a transaction because it doesn't include the
|
641
685
|
# `transactionID` parameter, changes that result from the call are
|
642
686
|
# committed automatically.
|
643
687
|
#
|
644
|
-
#
|
645
|
-
#
|
688
|
+
# If the binary response data from the database is more than 1 MB, the
|
689
|
+
# call is terminated.
|
646
690
|
#
|
647
|
-
#
|
648
|
-
# A value that indicates whether to continue running the statement after
|
649
|
-
# the call times out. By default, the statement stops running when the
|
650
|
-
# call times out.
|
691
|
+
# </note>
|
651
692
|
#
|
652
|
-
#
|
653
|
-
#
|
654
|
-
# finished running, it can result in errors and possibly corrupted data
|
655
|
-
# structures.
|
693
|
+
# @option params [required, String] :resource_arn
|
694
|
+
# The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
|
656
695
|
#
|
657
|
-
# @option params [String] :
|
658
|
-
# The
|
696
|
+
# @option params [required, String] :secret_arn
|
697
|
+
# The ARN of the secret that enables access to the DB cluster. Enter the
|
698
|
+
# database user name and password for the credentials in the secret.
|
659
699
|
#
|
660
|
-
#
|
661
|
-
#
|
700
|
+
# For information about creating the secret, see [Create a database
|
701
|
+
# secret][1].
|
662
702
|
#
|
663
|
-
# @option params [Array<Types::SqlParameter>] :parameters
|
664
|
-
# The parameters for the SQL statement.
|
665
703
|
#
|
666
|
-
# <note markdown="1"> Array parameters are not supported.
|
667
704
|
#
|
668
|
-
#
|
705
|
+
# [1]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_database_secret.html
|
669
706
|
#
|
670
|
-
# @option params [required, String] :
|
671
|
-
# The
|
707
|
+
# @option params [required, String] :sql
|
708
|
+
# The SQL statement to run.
|
672
709
|
#
|
673
|
-
# @option params [
|
674
|
-
#
|
710
|
+
# @option params [String] :database
|
711
|
+
# The name of the database.
|
675
712
|
#
|
676
713
|
# @option params [String] :schema
|
677
714
|
# The name of the database schema.
|
@@ -680,11 +717,12 @@ module Aws::RDSDataService
|
|
680
717
|
#
|
681
718
|
# </note>
|
682
719
|
#
|
683
|
-
# @option params [
|
684
|
-
# The
|
720
|
+
# @option params [Array<Types::SqlParameter>] :parameters
|
721
|
+
# The parameters for the SQL statement.
|
685
722
|
#
|
686
|
-
#
|
687
|
-
#
|
723
|
+
# <note markdown="1"> Array parameters are not supported.
|
724
|
+
#
|
725
|
+
# </note>
|
688
726
|
#
|
689
727
|
# @option params [String] :transaction_id
|
690
728
|
# The identifier of a transaction that was started by using the
|
@@ -694,107 +732,143 @@ module Aws::RDSDataService
|
|
694
732
|
# If the SQL statement is not part of a transaction, don't set this
|
695
733
|
# parameter.
|
696
734
|
#
|
735
|
+
# @option params [Boolean] :include_result_metadata
|
736
|
+
# A value that indicates whether to include metadata in the results.
|
737
|
+
#
|
738
|
+
# @option params [Boolean] :continue_after_timeout
|
739
|
+
# A value that indicates whether to continue running the statement after
|
740
|
+
# the call times out. By default, the statement stops running when the
|
741
|
+
# call times out.
|
742
|
+
#
|
743
|
+
# <note markdown="1"> For DDL statements, we recommend continuing to run the statement after
|
744
|
+
# the call times out. When a DDL statement terminates before it is
|
745
|
+
# finished running, it can result in errors and possibly corrupted data
|
746
|
+
# structures.
|
747
|
+
#
|
748
|
+
# </note>
|
749
|
+
#
|
750
|
+
# @option params [Types::ResultSetOptions] :result_set_options
|
751
|
+
# Options that control how the result set is returned.
|
752
|
+
#
|
753
|
+
# @option params [String] :format_records_as
|
754
|
+
# A value that indicates whether to format the result set as a single
|
755
|
+
# JSON string. This parameter only applies to `SELECT` statements and is
|
756
|
+
# ignored for other types of statements. Allowed values are `NONE` and
|
757
|
+
# `JSON`. The default value is `NONE`. The result is returned in the
|
758
|
+
# `formattedRecords` field.
|
759
|
+
#
|
760
|
+
# For usage information about the JSON format for result sets, see
|
761
|
+
# [Using the Data API][1] in the *Amazon Aurora User Guide*.
|
762
|
+
#
|
763
|
+
#
|
764
|
+
#
|
765
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
766
|
+
#
|
697
767
|
# @return [Types::ExecuteStatementResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
698
768
|
#
|
769
|
+
# * {Types::ExecuteStatementResponse#records #records} => Array<Array<Types::Field>>
|
699
770
|
# * {Types::ExecuteStatementResponse#column_metadata #column_metadata} => Array<Types::ColumnMetadata>
|
700
|
-
# * {Types::ExecuteStatementResponse#generated_fields #generated_fields} => Array<Types::Field>
|
701
771
|
# * {Types::ExecuteStatementResponse#number_of_records_updated #number_of_records_updated} => Integer
|
702
|
-
# * {Types::ExecuteStatementResponse#
|
772
|
+
# * {Types::ExecuteStatementResponse#generated_fields #generated_fields} => Array<Types::Field>
|
773
|
+
# * {Types::ExecuteStatementResponse#formatted_records #formatted_records} => String
|
703
774
|
#
|
704
775
|
# @example Request syntax with placeholder values
|
705
776
|
#
|
706
777
|
# resp = client.execute_statement({
|
707
|
-
#
|
778
|
+
# resource_arn: "Arn", # required
|
779
|
+
# secret_arn: "Arn", # required
|
780
|
+
# sql: "SqlStatement", # required
|
708
781
|
# database: "DbName",
|
709
|
-
#
|
782
|
+
# schema: "DbName",
|
710
783
|
# parameters: [
|
711
784
|
# {
|
712
785
|
# name: "ParameterName",
|
713
|
-
# type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
|
714
786
|
# value: {
|
787
|
+
# is_null: false,
|
788
|
+
# boolean_value: false,
|
789
|
+
# long_value: 1,
|
790
|
+
# double_value: 1.0,
|
791
|
+
# string_value: "String",
|
792
|
+
# blob_value: "data",
|
715
793
|
# array_value: {
|
794
|
+
# boolean_values: [false],
|
795
|
+
# long_values: [1],
|
796
|
+
# double_values: [1.0],
|
797
|
+
# string_values: ["String"],
|
716
798
|
# array_values: [
|
717
799
|
# {
|
718
800
|
# # recursive ArrayValue
|
719
801
|
# },
|
720
802
|
# ],
|
721
|
-
# boolean_values: [false],
|
722
|
-
# double_values: [1.0],
|
723
|
-
# long_values: [1],
|
724
|
-
# string_values: ["String"],
|
725
803
|
# },
|
726
|
-
# blob_value: "data",
|
727
|
-
# boolean_value: false,
|
728
|
-
# double_value: 1.0,
|
729
|
-
# is_null: false,
|
730
|
-
# long_value: 1,
|
731
|
-
# string_value: "String",
|
732
804
|
# },
|
805
|
+
# type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
|
733
806
|
# },
|
734
807
|
# ],
|
735
|
-
#
|
808
|
+
# transaction_id: "Id",
|
809
|
+
# include_result_metadata: false,
|
810
|
+
# continue_after_timeout: false,
|
736
811
|
# result_set_options: {
|
737
812
|
# decimal_return_type: "STRING", # accepts STRING, DOUBLE_OR_LONG
|
813
|
+
# long_return_type: "STRING", # accepts STRING, LONG
|
738
814
|
# },
|
739
|
-
#
|
740
|
-
# secret_arn: "Arn", # required
|
741
|
-
# sql: "SqlStatement", # required
|
742
|
-
# transaction_id: "Id",
|
815
|
+
# format_records_as: "NONE", # accepts NONE, JSON
|
743
816
|
# })
|
744
817
|
#
|
745
818
|
# @example Response structure
|
746
819
|
#
|
820
|
+
# resp.records #=> Array
|
821
|
+
# resp.records[0] #=> Array
|
822
|
+
# resp.records[0][0].is_null #=> Boolean
|
823
|
+
# resp.records[0][0].boolean_value #=> Boolean
|
824
|
+
# resp.records[0][0].long_value #=> Integer
|
825
|
+
# resp.records[0][0].double_value #=> Float
|
826
|
+
# resp.records[0][0].string_value #=> String
|
827
|
+
# resp.records[0][0].blob_value #=> String
|
828
|
+
# resp.records[0][0].array_value.boolean_values #=> Array
|
829
|
+
# resp.records[0][0].array_value.boolean_values[0] #=> Boolean
|
830
|
+
# resp.records[0][0].array_value.long_values #=> Array
|
831
|
+
# resp.records[0][0].array_value.long_values[0] #=> Integer
|
832
|
+
# resp.records[0][0].array_value.double_values #=> Array
|
833
|
+
# resp.records[0][0].array_value.double_values[0] #=> Float
|
834
|
+
# resp.records[0][0].array_value.string_values #=> Array
|
835
|
+
# resp.records[0][0].array_value.string_values[0] #=> String
|
836
|
+
# resp.records[0][0].array_value.array_values #=> Array
|
837
|
+
# resp.records[0][0].array_value.array_values[0] #=> Types::ArrayValue
|
747
838
|
# resp.column_metadata #=> Array
|
748
|
-
# resp.column_metadata[0].
|
839
|
+
# resp.column_metadata[0].name #=> String
|
840
|
+
# resp.column_metadata[0].type #=> Integer
|
841
|
+
# resp.column_metadata[0].type_name #=> String
|
842
|
+
# resp.column_metadata[0].label #=> String
|
843
|
+
# resp.column_metadata[0].schema_name #=> String
|
844
|
+
# resp.column_metadata[0].table_name #=> String
|
749
845
|
# resp.column_metadata[0].is_auto_increment #=> Boolean
|
750
|
-
# resp.column_metadata[0].is_case_sensitive #=> Boolean
|
751
|
-
# resp.column_metadata[0].is_currency #=> Boolean
|
752
846
|
# resp.column_metadata[0].is_signed #=> Boolean
|
753
|
-
# resp.column_metadata[0].
|
754
|
-
# resp.column_metadata[0].
|
847
|
+
# resp.column_metadata[0].is_currency #=> Boolean
|
848
|
+
# resp.column_metadata[0].is_case_sensitive #=> Boolean
|
755
849
|
# resp.column_metadata[0].nullable #=> Integer
|
756
850
|
# resp.column_metadata[0].precision #=> Integer
|
757
851
|
# resp.column_metadata[0].scale #=> Integer
|
758
|
-
# resp.column_metadata[0].
|
759
|
-
# resp.
|
760
|
-
# resp.column_metadata[0].type #=> Integer
|
761
|
-
# resp.column_metadata[0].type_name #=> String
|
852
|
+
# resp.column_metadata[0].array_base_column_type #=> Integer
|
853
|
+
# resp.number_of_records_updated #=> Integer
|
762
854
|
# resp.generated_fields #=> Array
|
763
|
-
# resp.generated_fields[0].
|
764
|
-
# resp.generated_fields[0].
|
855
|
+
# resp.generated_fields[0].is_null #=> Boolean
|
856
|
+
# resp.generated_fields[0].boolean_value #=> Boolean
|
857
|
+
# resp.generated_fields[0].long_value #=> Integer
|
858
|
+
# resp.generated_fields[0].double_value #=> Float
|
859
|
+
# resp.generated_fields[0].string_value #=> String
|
860
|
+
# resp.generated_fields[0].blob_value #=> String
|
765
861
|
# resp.generated_fields[0].array_value.boolean_values #=> Array
|
766
862
|
# resp.generated_fields[0].array_value.boolean_values[0] #=> Boolean
|
767
|
-
# resp.generated_fields[0].array_value.double_values #=> Array
|
768
|
-
# resp.generated_fields[0].array_value.double_values[0] #=> Float
|
769
863
|
# resp.generated_fields[0].array_value.long_values #=> Array
|
770
864
|
# resp.generated_fields[0].array_value.long_values[0] #=> Integer
|
865
|
+
# resp.generated_fields[0].array_value.double_values #=> Array
|
866
|
+
# resp.generated_fields[0].array_value.double_values[0] #=> Float
|
771
867
|
# resp.generated_fields[0].array_value.string_values #=> Array
|
772
868
|
# resp.generated_fields[0].array_value.string_values[0] #=> String
|
773
|
-
# resp.generated_fields[0].
|
774
|
-
# resp.generated_fields[0].
|
775
|
-
# resp.
|
776
|
-
# resp.generated_fields[0].is_null #=> Boolean
|
777
|
-
# resp.generated_fields[0].long_value #=> Integer
|
778
|
-
# resp.generated_fields[0].string_value #=> String
|
779
|
-
# resp.number_of_records_updated #=> Integer
|
780
|
-
# resp.records #=> Array
|
781
|
-
# resp.records[0] #=> Array
|
782
|
-
# resp.records[0][0].array_value.array_values #=> Array
|
783
|
-
# resp.records[0][0].array_value.array_values[0] #=> Types::ArrayValue
|
784
|
-
# resp.records[0][0].array_value.boolean_values #=> Array
|
785
|
-
# resp.records[0][0].array_value.boolean_values[0] #=> Boolean
|
786
|
-
# resp.records[0][0].array_value.double_values #=> Array
|
787
|
-
# resp.records[0][0].array_value.double_values[0] #=> Float
|
788
|
-
# resp.records[0][0].array_value.long_values #=> Array
|
789
|
-
# resp.records[0][0].array_value.long_values[0] #=> Integer
|
790
|
-
# resp.records[0][0].array_value.string_values #=> Array
|
791
|
-
# resp.records[0][0].array_value.string_values[0] #=> String
|
792
|
-
# resp.records[0][0].blob_value #=> String
|
793
|
-
# resp.records[0][0].boolean_value #=> Boolean
|
794
|
-
# resp.records[0][0].double_value #=> Float
|
795
|
-
# resp.records[0][0].is_null #=> Boolean
|
796
|
-
# resp.records[0][0].long_value #=> Integer
|
797
|
-
# resp.records[0][0].string_value #=> String
|
869
|
+
# resp.generated_fields[0].array_value.array_values #=> Array
|
870
|
+
# resp.generated_fields[0].array_value.array_values[0] #=> Types::ArrayValue
|
871
|
+
# resp.formatted_records #=> String
|
798
872
|
#
|
799
873
|
# @see http://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteStatement AWS API Documentation
|
800
874
|
#
|
@@ -855,7 +929,7 @@ module Aws::RDSDataService
|
|
855
929
|
params: params,
|
856
930
|
config: config)
|
857
931
|
context[:gem_name] = 'aws-sdk-rdsdataservice'
|
858
|
-
context[:gem_version] = '1.
|
932
|
+
context[:gem_version] = '1.37.0'
|
859
933
|
Seahorse::Client::Request.new(handlers, context)
|
860
934
|
end
|
861
935
|
|