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