Class: Aws::RDSDataService::Types::SqlParameter

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rdsdataservice/types.rb

Overview

Note:

When making an API call, you may pass SqlParameter data as a hash:

{
  name: "ParameterName",
  type_hint: "JSON", # accepts JSON, UUID, TIMESTAMP, DATE, TIME, DECIMAL
  value: {
    array_value: {
      array_values: [
        {
          # recursive ArrayValue
        },
      ],
      boolean_values: [false],
      double_values: [1.0],
      long_values: [1],
      string_values: ["String"],
    },
    blob_value: "data",
    boolean_value: false,
    double_value: 1.0,
    is_null: false,
    long_value: 1,
    string_value: "String",
  },
}

A parameter used in a SQL statement.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name of the parameter.

Returns:

  • (String) 


889
890
891
892
893
894
895
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 889

class SqlParameter < Struct.new(
  :name,
  :type_hint,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#type_hint ⇒ String

A hint that specifies the correct object type for data type mapping. Possible values are as follows:

  • ‘DATE` - The corresponding `String` parameter value is sent as an object of `DATE` type to the database. The accepted format is `YYYY-MM-DD`.

  • ‘DECIMAL` - The corresponding `String` parameter value is sent as an object of `DECIMAL` type to the database.

  • ‘JSON` - The corresponding `String` parameter value is sent as an object of `JSON` type to the database.

  • ‘TIME` - The corresponding `String` parameter value is sent as an object of `TIME` type to the database. The accepted format is `HH:MM:SS`.

  • ‘TIMESTAMP` - The corresponding `String` parameter value is sent as an object of `TIMESTAMP` type to the database. The accepted format is `YYYY-MM-DD HH:MM:SS`.

  • ‘UUID` - The corresponding `String` parameter value is sent as an object of `UUID` type to the database.

Returns:

  • (String) 


889
890
891
892
893
894
895
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 889

class SqlParameter < Struct.new(
  :name,
  :type_hint,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Types::Field

The value of the parameter.

Returns:



889
890
891
892
893
894
895
 
# File 'lib/aws-sdk-rdsdataservice/types.rb', line 889

class SqlParameter < Struct.new(
  :name,
  :type_hint,
  :value)
  SENSITIVE = []
  include Aws::Structure
end