You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SqlParameter as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "ParameterName",
  type_hint: "DATE", # accepts DATE, DECIMAL, TIME, TIMESTAMP
  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:

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

The name of the parameter.

Returns:

  • (String) —

    The name of the parameter.

#type_hint ⇒ String

A hint that specifies the correct object type for data type mapping.

Values:

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

  • 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[.FFF].

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

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

    Possible values:

    • DATE
    • DECIMAL
    • TIME
    • TIMESTAMP

Returns:

  • (String) —

    A hint that specifies the correct object type for data type mapping.

#value ⇒ Types::Field

The value of the parameter.

Returns: