Class: OCI::Nosql::NosqlClient
- Inherits:
-
Object
- Object
- OCI::Nosql::NosqlClient
- Defined in:
- lib/oci/nosql/nosql_client.rb
Overview
The control plane API for NoSQL Database Cloud Service HTTPS provides endpoints to perform NDCS operations, including creation and deletion of tables and indexes; population and access of data in tables; and access of table usage metrics.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#change_table_compartment(table_name_or_id, change_table_compartment_details, opts = {}) ⇒ Response
Change a table's compartment.
-
#create_index(table_name_or_id, create_index_details, opts = {}) ⇒ Response
Create a new index on the table identified by tableNameOrId.
-
#create_replica(table_name_or_id, create_replica_details, opts = {}) ⇒ Response
Add a replica for this table.
-
#create_table(create_table_details, opts = {}) ⇒ Response
Create a new table.
-
#delete_index(table_name_or_id, index_name, opts = {}) ⇒ Response
Delete an index from the table identified by tableNameOrId.
-
#delete_replica(table_name_or_id, region, opts = {}) ⇒ Response
Delete the specified replica table in the remote region.
-
#delete_row(table_name_or_id, key, opts = {}) ⇒ Response
Delete a single row from the table, by primary key.
-
#delete_table(table_name_or_id, opts = {}) ⇒ Response
Delete a table by tableNameOrId.
-
#delete_work_request(work_request_id, opts = {}) ⇒ Response
Cancel a work request operation with the given ID.
-
#get_index(table_name_or_id, index_name, opts = {}) ⇒ Response
Get information about a single index.
-
#get_row(table_name_or_id, key, opts = {}) ⇒ Response
Get a single row from the table by primary key.
-
#get_table(table_name_or_id, opts = {}) ⇒ Response
Get table info by identifier.
-
#get_work_request(work_request_id, opts = {}) ⇒ Response
Get the status of the work request with the given ID.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ NosqlClient
constructor
Creates a new NosqlClient.
-
#list_indexes(table_name_or_id, opts = {}) ⇒ Response
Get a list of indexes on a table.
-
#list_table_usage(table_name_or_id, opts = {}) ⇒ Response
Get table usage info.
-
#list_tables(compartment_id, opts = {}) ⇒ Response
Get a list of tables in a compartment.
-
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Return a (paginated) list of errors for a given work request.
-
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Return a (paginated) list of logs for a given work request.
-
#list_work_requests(compartment_id, opts = {}) ⇒ Response
List the work requests in a compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#prepare_statement(compartment_id, statement, opts = {}) ⇒ Response
Prepare a SQL statement for use in a query with variable substitution.
-
#query(query_details, opts = {}) ⇒ Response
Execute a SQL query.
-
#summarize_statement(compartment_id, statement, opts = {}) ⇒ Response
Check the syntax and return a brief summary of a SQL statement.
-
#update_row(table_name_or_id, update_row_details, opts = {}) ⇒ Response
Write a single row into the table.
-
#update_table(table_name_or_id, update_table_details, opts = {}) ⇒ Response
Alter the table identified by tableNameOrId, changing schema, limits, or tags.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ NosqlClient
Creates a new NosqlClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/oci/nosql/nosql_client.rb', line 58 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20190828' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "NosqlClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
18 19 20 |
# File 'lib/oci/nosql/nosql_client.rb', line 18 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
22 23 24 |
# File 'lib/oci/nosql/nosql_client.rb', line 22 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
32 33 34 |
# File 'lib/oci/nosql/nosql_client.rb', line 32 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
28 29 30 |
# File 'lib/oci/nosql/nosql_client.rb', line 28 def retry_config @retry_config end |
Instance Method Details
#change_table_compartment(table_name_or_id, change_table_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_table_compartment API.
Change a table's compartment.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/oci/nosql/nosql_client.rb', line 129 def change_table_compartment(table_name_or_id, change_table_compartment_details, opts = {}) logger.debug 'Calling operation NosqlClient#change_table_compartment.' if logger raise "Missing the required parameter 'table_name_or_id' when calling change_table_compartment." if table_name_or_id.nil? raise "Missing the required parameter 'change_table_compartment_details' when calling change_table_compartment." if change_table_compartment_details.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}/actions/changeCompartment'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_table_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#change_table_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_index(table_name_or_id, create_index_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_index API.
Create a new index on the table identified by tableNameOrId.
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/oci/nosql/nosql_client.rb', line 195 def create_index(table_name_or_id, create_index_details, opts = {}) logger.debug 'Calling operation NosqlClient#create_index.' if logger raise "Missing the required parameter 'table_name_or_id' when calling create_index." if table_name_or_id.nil? raise "Missing the required parameter 'create_index_details' when calling create_index." if create_index_details.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}/indexes'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_index_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#create_index') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_replica(table_name_or_id, create_replica_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_replica API.
Add a replica for this table
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/oci/nosql/nosql_client.rb', line 266 def create_replica(table_name_or_id, create_replica_details, opts = {}) logger.debug 'Calling operation NosqlClient#create_replica.' if logger raise "Missing the required parameter 'table_name_or_id' when calling create_replica." if table_name_or_id.nil? raise "Missing the required parameter 'create_replica_details' when calling create_replica." if create_replica_details.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}/replicas'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_replica_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#create_replica') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_table(create_table_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_table API.
Create a new table.
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/oci/nosql/nosql_client.rb', line 331 def create_table(create_table_details, opts = {}) logger.debug 'Calling operation NosqlClient#create_table.' if logger raise "Missing the required parameter 'create_table_details' when calling create_table." if create_table_details.nil? path = '/tables' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_table_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#create_table') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_index(table_name_or_id, index_name, opts = {}) ⇒ Response
Click here to see an example of how to use delete_index API.
Delete an index from the table identified by tableNameOrId.
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 |
# File 'lib/oci/nosql/nosql_client.rb', line 397 def delete_index(table_name_or_id, index_name, opts = {}) logger.debug 'Calling operation NosqlClient#delete_index.' if logger raise "Missing the required parameter 'table_name_or_id' when calling delete_index." if table_name_or_id.nil? raise "Missing the required parameter 'index_name' when calling delete_index." if index_name.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) raise "Parameter value for 'index_name' must not be blank" if OCI::Internal::Util.blank_string?(index_name) path = '/tables/{tableNameOrId}/indexes/{indexName}'.sub('{tableNameOrId}', table_name_or_id.to_s).sub('{indexName}', index_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:isIfExists] = opts[:is_if_exists] if !opts[:is_if_exists].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#delete_index') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_replica(table_name_or_id, region, opts = {}) ⇒ Response
Click here to see an example of how to use delete_replica API.
Delete the specified replica table in the remote region.
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 |
# File 'lib/oci/nosql/nosql_client.rb', line 466 def delete_replica(table_name_or_id, region, opts = {}) logger.debug 'Calling operation NosqlClient#delete_replica.' if logger raise "Missing the required parameter 'table_name_or_id' when calling delete_replica." if table_name_or_id.nil? raise "Missing the required parameter 'region' when calling delete_replica." if region.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) raise "Parameter value for 'region' must not be blank" if OCI::Internal::Util.blank_string?(region) path = '/tables/{tableNameOrId}/replicas/{region}'.sub('{tableNameOrId}', table_name_or_id.to_s).sub('{region}', region.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#delete_replica') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_row(table_name_or_id, key, opts = {}) ⇒ Response
Click here to see an example of how to use delete_row API.
Delete a single row from the table, by primary key.
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
# File 'lib/oci/nosql/nosql_client.rb', line 540 def delete_row(table_name_or_id, key, opts = {}) logger.debug 'Calling operation NosqlClient#delete_row.' if logger raise "Missing the required parameter 'table_name_or_id' when calling delete_row." if table_name_or_id.nil? raise "Missing the required parameter 'key' when calling delete_row." if key.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}/rows'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = OCI::ApiClient.build_collection_params(key, :multi) query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:isGetReturnRow] = opts[:is_get_return_row] if !opts[:is_get_return_row].nil? query_params[:timeoutInMs] = opts[:timeout_in_ms] if opts[:timeout_in_ms] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#delete_row') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::DeleteRowResult' ) end # rubocop:enable Metrics/BlockLength end |
#delete_table(table_name_or_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_table API.
Delete a table by tableNameOrId.
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 |
# File 'lib/oci/nosql/nosql_client.rb', line 611 def delete_table(table_name_or_id, opts = {}) logger.debug 'Calling operation NosqlClient#delete_table.' if logger raise "Missing the required parameter 'table_name_or_id' when calling delete_table." if table_name_or_id.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:isIfExists] = opts[:is_if_exists] if !opts[:is_if_exists].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#delete_table') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_work_request API.
Cancel a work request operation with the given ID.
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 |
# File 'lib/oci/nosql/nosql_client.rb', line 673 def delete_work_request(work_request_id, opts = {}) logger.debug 'Calling operation NosqlClient#delete_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling delete_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#delete_work_request') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#get_index(table_name_or_id, index_name, opts = {}) ⇒ Response
Click here to see an example of how to use get_index API.
Get information about a single index.
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 |
# File 'lib/oci/nosql/nosql_client.rb', line 732 def get_index(table_name_or_id, index_name, opts = {}) logger.debug 'Calling operation NosqlClient#get_index.' if logger raise "Missing the required parameter 'table_name_or_id' when calling get_index." if table_name_or_id.nil? raise "Missing the required parameter 'index_name' when calling get_index." if index_name.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) raise "Parameter value for 'index_name' must not be blank" if OCI::Internal::Util.blank_string?(index_name) path = '/tables/{tableNameOrId}/indexes/{indexName}'.sub('{tableNameOrId}', table_name_or_id.to_s).sub('{indexName}', index_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#get_index') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::Index' ) end # rubocop:enable Metrics/BlockLength end |
#get_row(table_name_or_id, key, opts = {}) ⇒ Response
Click here to see an example of how to use get_row API.
Get a single row from the table by primary key.
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 |
# File 'lib/oci/nosql/nosql_client.rb', line 799 def get_row(table_name_or_id, key, opts = {}) logger.debug 'Calling operation NosqlClient#get_row.' if logger raise "Missing the required parameter 'table_name_or_id' when calling get_row." if table_name_or_id.nil? raise "Missing the required parameter 'key' when calling get_row." if key.nil? if opts[:consistency] && !%w[EVENTUAL ABSOLUTE].include?(opts[:consistency]) raise 'Invalid value for "consistency", must be one of EVENTUAL, ABSOLUTE.' end raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}/rows'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:key] = OCI::ApiClient.build_collection_params(key, :multi) query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:consistency] = opts[:consistency] if opts[:consistency] query_params[:timeoutInMs] = opts[:timeout_in_ms] if opts[:timeout_in_ms] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#get_row') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::Row' ) end # rubocop:enable Metrics/BlockLength end |
#get_table(table_name_or_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_table API.
Get table info by identifier.
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 |
# File 'lib/oci/nosql/nosql_client.rb', line 866 def get_table(table_name_or_id, opts = {}) logger.debug 'Calling operation NosqlClient#get_table.' if logger raise "Missing the required parameter 'table_name_or_id' when calling get_table." if table_name_or_id.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#get_table') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::Table' ) end # rubocop:enable Metrics/BlockLength end |
#get_work_request(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_work_request API.
Get the status of the work request with the given ID.
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 |
# File 'lib/oci/nosql/nosql_client.rb', line 921 def get_work_request(work_request_id, opts = {}) logger.debug 'Calling operation NosqlClient#get_work_request.' if logger raise "Missing the required parameter 'work_request_id' when calling get_work_request." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#get_work_request') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::WorkRequest' ) end # rubocop:enable Metrics/BlockLength end |
#list_indexes(table_name_or_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_indexes API.
Get a list of indexes on a table.
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 |
# File 'lib/oci/nosql/nosql_client.rb', line 995 def list_indexes(table_name_or_id, opts = {}) logger.debug 'Calling operation NosqlClient#list_indexes.' if logger raise "Missing the required parameter 'table_name_or_id' when calling list_indexes." if table_name_or_id.nil? if opts[:lifecycle_state] && !%w[ALL CREATING UPDATING ACTIVE DELETING DELETED FAILED INACTIVE].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of ALL, CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, INACTIVE.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timeCreated name].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, name.' end raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}/indexes'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:name] = opts[:name] if opts[:name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#list_indexes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::IndexCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_table_usage(table_name_or_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_table_usage API.
Get table usage info.
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 |
# File 'lib/oci/nosql/nosql_client.rb', line 1082 def list_table_usage(table_name_or_id, opts = {}) logger.debug 'Calling operation NosqlClient#list_table_usage.' if logger raise "Missing the required parameter 'table_name_or_id' when calling list_table_usage." if table_name_or_id.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}/usage'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:timeStart] = opts[:time_start] if opts[:time_start] query_params[:timeEnd] = opts[:time_end] if opts[:time_end] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#list_table_usage') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::TableUsageCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_tables(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_tables API.
Get a list of tables in a compartment.
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 |
# File 'lib/oci/nosql/nosql_client.rb', line 1157 def list_tables(compartment_id, opts = {}) logger.debug 'Calling operation NosqlClient#list_tables.' if logger raise "Missing the required parameter 'compartment_id' when calling list_tables." if compartment_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:sort_by] && !%w[timeCreated name].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of timeCreated, name.' end if opts[:lifecycle_state] && !%w[ALL CREATING UPDATING ACTIVE DELETING DELETED FAILED INACTIVE].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of ALL, CREATING, UPDATING, ACTIVE, DELETING, DELETED, FAILED, INACTIVE.' end path = '/tables' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:name] = opts[:name] if opts[:name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#list_tables') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::TableCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_errors(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_errors API.
Return a (paginated) list of errors for a given work request.
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 |
# File 'lib/oci/nosql/nosql_client.rb', line 1235 def list_work_request_errors(work_request_id, opts = {}) logger.debug 'Calling operation NosqlClient#list_work_request_errors.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#list_work_request_errors') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::WorkRequestErrorCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_request_logs(work_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_request_logs API.
Return a (paginated) list of logs for a given work request.
1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 |
# File 'lib/oci/nosql/nosql_client.rb', line 1297 def list_work_request_logs(work_request_id, opts = {}) logger.debug 'Calling operation NosqlClient#list_work_request_logs.' if logger raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil? raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id) path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#list_work_request_logs') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::WorkRequestLogEntryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_work_requests(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_work_requests API.
List the work requests in a compartment.
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 |
# File 'lib/oci/nosql/nosql_client.rb', line 1358 def list_work_requests(compartment_id, opts = {}) logger.debug 'Calling operation NosqlClient#list_work_requests.' if logger raise "Missing the required parameter 'compartment_id' when calling list_work_requests." if compartment_id.nil? path = '/workRequests' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:page] = opts[:page] if opts[:page] query_params[:limit] = opts[:limit] if opts[:limit] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#list_work_requests') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::WorkRequestCollection' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
97 98 99 |
# File 'lib/oci/nosql/nosql_client.rb', line 97 def logger @api_client.config.logger end |
#prepare_statement(compartment_id, statement, opts = {}) ⇒ Response
Click here to see an example of how to use prepare_statement API.
Prepare a SQL statement for use in a query with variable substitution.
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 |
# File 'lib/oci/nosql/nosql_client.rb', line 1417 def prepare_statement(compartment_id, statement, opts = {}) logger.debug 'Calling operation NosqlClient#prepare_statement.' if logger raise "Missing the required parameter 'compartment_id' when calling prepare_statement." if compartment_id.nil? raise "Missing the required parameter 'statement' when calling prepare_statement." if statement.nil? path = '/query/prepare' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:statement] = statement query_params[:isGetQueryPlan] = opts[:is_get_query_plan] if !opts[:is_get_query_plan].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#prepare_statement') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::PreparedStatement' ) end # rubocop:enable Metrics/BlockLength end |
#query(query_details, opts = {}) ⇒ Response
Click here to see an example of how to use query API.
Execute a SQL query.
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 |
# File 'lib/oci/nosql/nosql_client.rb', line 1479 def query(query_details, opts = {}) logger.debug 'Calling operation NosqlClient#query.' if logger raise "Missing the required parameter 'query_details' when calling query." if query_details.nil? path = '/query' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(query_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#query') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::QueryResultCollection' ) end # rubocop:enable Metrics/BlockLength end |
#summarize_statement(compartment_id, statement, opts = {}) ⇒ Response
Click here to see an example of how to use summarize_statement API.
Check the syntax and return a brief summary of a SQL statement.
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 |
# File 'lib/oci/nosql/nosql_client.rb', line 1536 def summarize_statement(compartment_id, statement, opts = {}) logger.debug 'Calling operation NosqlClient#summarize_statement.' if logger raise "Missing the required parameter 'compartment_id' when calling summarize_statement." if compartment_id.nil? raise "Missing the required parameter 'statement' when calling summarize_statement." if statement.nil? path = '/query/summarize' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:statement] = statement # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#summarize_statement') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::StatementSummary' ) end # rubocop:enable Metrics/BlockLength end |
#update_row(table_name_or_id, update_row_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_row API.
Write a single row into the table.
1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 |
# File 'lib/oci/nosql/nosql_client.rb', line 1599 def update_row(table_name_or_id, update_row_details, opts = {}) logger.debug 'Calling operation NosqlClient#update_row.' if logger raise "Missing the required parameter 'table_name_or_id' when calling update_row." if table_name_or_id.nil? raise "Missing the required parameter 'update_row_details' when calling update_row." if update_row_details.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}/rows'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_row_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#update_row') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Nosql::Models::UpdateRowResult' ) end # rubocop:enable Metrics/BlockLength end |
#update_table(table_name_or_id, update_table_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_table API.
Alter the table identified by tableNameOrId, changing schema, limits, or tags
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 |
# File 'lib/oci/nosql/nosql_client.rb', line 1664 def update_table(table_name_or_id, update_table_details, opts = {}) logger.debug 'Calling operation NosqlClient#update_table.' if logger raise "Missing the required parameter 'table_name_or_id' when calling update_table." if table_name_or_id.nil? raise "Missing the required parameter 'update_table_details' when calling update_table." if update_table_details.nil? raise "Parameter value for 'table_name_or_id' must not be blank" if OCI::Internal::Util.blank_string?(table_name_or_id) path = '/tables/{tableNameOrId}'.sub('{tableNameOrId}', table_name_or_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_table_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'NosqlClient#update_table') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |