rdsdataservice

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 25, 2019 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package rdsdataservice provides the client and types for making API requests to AWS RDS DataService.

AWS RDS DataService provides Http Endpoint to query RDS databases.

See https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01 for more information on this service.

See rdsdataservice package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/rdsdataservice/

Using the Client

To AWS RDS DataService with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS RDS DataService client RDSDataService for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/rdsdataservice/#New

Index

Constants

View Source
const (

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// Invalid Request exception
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeForbiddenException for service response error code
	// "ForbiddenException".
	//
	// Access denied exception
	ErrCodeForbiddenException = "ForbiddenException"

	// ErrCodeInternalServerErrorException for service response error code
	// "InternalServerErrorException".
	//
	// Internal service error
	ErrCodeInternalServerErrorException = "InternalServerErrorException"

	// ErrCodeServiceUnavailableError for service response error code
	// "ServiceUnavailableError".
	//
	// Internal service unavailable error
	ErrCodeServiceUnavailableError = "ServiceUnavailableError"
)
View Source
const (
	ServiceName = "rds-data"  // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type ColumnMetadata

type ColumnMetadata struct {

	// Homogenous array base SQL type from java.sql.Types.
	ArrayBaseColumnType *int64 `locationName:"arrayBaseColumnType" type:"integer"`

	// Whether the designated column is automatically numbered
	IsAutoIncrement *bool `locationName:"isAutoIncrement" type:"boolean"`

	// Whether values in the designated column's case matters
	IsCaseSensitive *bool `locationName:"isCaseSensitive" type:"boolean"`

	// Whether values in the designated column is a cash value
	IsCurrency *bool `locationName:"isCurrency" type:"boolean"`

	// Whether values in the designated column are signed numbers
	IsSigned *bool `locationName:"isSigned" type:"boolean"`

	// Usually specified by the SQL AS. If not specified, return column name.
	Label *string `locationName:"label" type:"string"`

	// Name of the column.
	Name *string `locationName:"name" type:"string"`

	// Indicates the nullability of values in the designated column. One of columnNoNulls
	// (0), columnNullable (1), columnNullableUnknown (2)
	Nullable *int64 `locationName:"nullable" type:"integer"`

	// Get the designated column's specified column size.For numeric data, this
	// is the maximum precision. For character data, this is the length in characters.
	// For datetime datatypes, this is the length in characters of the String representation
	// (assuming the maximum allowed precision of the fractional seconds component).
	// For binary data, this is the length in bytes. For the ROWID datatype, this
	// is the length in bytes. 0 is returned for data types where the column size
	// is not applicable.
	Precision *int64 `locationName:"precision" type:"integer"`

	// Designated column's number of digits to right of the decimal point. 0 is
	// returned for data types where the scale is not applicable.
	Scale *int64 `locationName:"scale" type:"integer"`

	// Designated column's table's schema
	SchemaName *string `locationName:"schemaName" type:"string"`

	// Designated column's table name
	TableName *string `locationName:"tableName" type:"string"`

	// SQL type from java.sql.Types.
	Type *int64 `locationName:"type" type:"integer"`

	// Database-specific type name.
	TypeName *string `locationName:"typeName" type:"string"`
	// contains filtered or unexported fields
}

Column Metadata Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ColumnMetadata

func (ColumnMetadata) GoString

func (s ColumnMetadata) GoString() string

GoString returns the string representation

func (ColumnMetadata) MarshalFields

func (s ColumnMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ColumnMetadata) String

func (s ColumnMetadata) String() string

String returns the string representation

type ExecuteSqlInput

type ExecuteSqlInput struct {

	// ARN of the db credentials in AWS Secret Store or the friendly secret name
	//
	// AwsSecretStoreArn is a required field
	AwsSecretStoreArn *string `locationName:"awsSecretStoreArn" type:"string" required:"true"`

	// Target DB name
	Database *string `locationName:"database" type:"string"`

	// ARN of the target db cluster or instance
	//
	// DbClusterOrInstanceArn is a required field
	DbClusterOrInstanceArn *string `locationName:"dbClusterOrInstanceArn" type:"string" required:"true"`

	// Target Schema name
	Schema *string `locationName:"schema" type:"string"`

	// SQL statement(s) to be executed. Statements can be chained by using semicolons
	//
	// SqlStatements is a required field
	SqlStatements *string `locationName:"sqlStatements" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Execute SQL Request Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSqlRequest

func (ExecuteSqlInput) GoString

func (s ExecuteSqlInput) GoString() string

GoString returns the string representation

func (ExecuteSqlInput) MarshalFields

func (s ExecuteSqlInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ExecuteSqlInput) String

func (s ExecuteSqlInput) String() string

String returns the string representation

func (*ExecuteSqlInput) Validate

func (s *ExecuteSqlInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExecuteSqlOutput

type ExecuteSqlOutput struct {

	// Results returned by executing the sql statement(s)
	//
	// SqlStatementResults is a required field
	SqlStatementResults []SqlStatementResult `locationName:"sqlStatementResults" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Execute SQL response Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSqlResponse

func (ExecuteSqlOutput) GoString

func (s ExecuteSqlOutput) GoString() string

GoString returns the string representation

func (ExecuteSqlOutput) MarshalFields

func (s ExecuteSqlOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ExecuteSqlOutput) SDKResponseMetadata

func (s ExecuteSqlOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ExecuteSqlOutput) String

func (s ExecuteSqlOutput) String() string

String returns the string representation

type ExecuteSqlRequest

type ExecuteSqlRequest struct {
	*aws.Request
	Input *ExecuteSqlInput
	Copy  func(*ExecuteSqlInput) ExecuteSqlRequest
}

ExecuteSqlRequest is a API request type for the ExecuteSql API operation.

func (ExecuteSqlRequest) Send

Send marshals and sends the ExecuteSql API request.

type RDSDataService

type RDSDataService struct {
	*aws.Client
}

RDSDataService provides the API operation methods for making requests to AWS RDS DataService. See this package's package overview docs for details on the service.

RDSDataService methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *RDSDataService

New creates a new instance of the RDSDataService client with a config.

Example:

// Create a RDSDataService client from just a config.
svc := rdsdataservice.New(myConfig)

func (*RDSDataService) ExecuteSqlRequest

func (c *RDSDataService) ExecuteSqlRequest(input *ExecuteSqlInput) ExecuteSqlRequest

ExecuteSqlRequest returns a request value for making API operation for AWS RDS DataService.

Executes any SQL statement on the target database synchronously

// Example sending a request using the ExecuteSqlRequest method.
req := client.ExecuteSqlRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ExecuteSql

type Record

type Record struct {

	// Record
	Values []Value `locationName:"values" type:"list"`
	// contains filtered or unexported fields
}

Row or Record Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Record

func (Record) GoString

func (s Record) GoString() string

GoString returns the string representation

func (Record) MarshalFields

func (s Record) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Record) String

func (s Record) String() string

String returns the string representation

type ResultFrame

type ResultFrame struct {

	// ResultSet Metadata.
	Records []Record `locationName:"records" type:"list"`

	// ResultSet Metadata.
	ResultSetMetadata *ResultSetMetadata `locationName:"resultSetMetadata" type:"structure"`
	// contains filtered or unexported fields
}

Result Frame Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ResultFrame

func (ResultFrame) GoString

func (s ResultFrame) GoString() string

GoString returns the string representation

func (ResultFrame) MarshalFields

func (s ResultFrame) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResultFrame) String

func (s ResultFrame) String() string

String returns the string representation

type ResultSetMetadata

type ResultSetMetadata struct {

	// Number of columns
	ColumnCount *int64 `locationName:"columnCount" type:"long"`

	// List of columns and their types
	ColumnMetadata []ColumnMetadata `locationName:"columnMetadata" type:"list"`
	// contains filtered or unexported fields
}

List of columns and their types. Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/ResultSetMetadata

func (ResultSetMetadata) GoString

func (s ResultSetMetadata) GoString() string

GoString returns the string representation

func (ResultSetMetadata) MarshalFields

func (s ResultSetMetadata) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ResultSetMetadata) String

func (s ResultSetMetadata) String() string

String returns the string representation

type SqlStatementResult

type SqlStatementResult struct {

	// Number of rows updated.
	NumberOfRecordsUpdated *int64 `locationName:"numberOfRecordsUpdated" type:"long"`

	// ResultFrame returned by executing the sql statement
	ResultFrame *ResultFrame `locationName:"resultFrame" type:"structure"`
	// contains filtered or unexported fields
}

SQL statement execution result Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/SqlStatementResult

func (SqlStatementResult) GoString

func (s SqlStatementResult) GoString() string

GoString returns the string representation

func (SqlStatementResult) MarshalFields

func (s SqlStatementResult) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (SqlStatementResult) String

func (s SqlStatementResult) String() string

String returns the string representation

type StructValue

type StructValue struct {

	// Struct or UDT
	Attributes []Value `locationName:"attributes" type:"list"`
	// contains filtered or unexported fields
}

User Defined Type Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/StructValue

func (StructValue) GoString

func (s StructValue) GoString() string

GoString returns the string representation

func (StructValue) MarshalFields

func (s StructValue) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (StructValue) String

func (s StructValue) String() string

String returns the string representation

type Value

type Value struct {

	// Arbitrarily nested arrays
	ArrayValues []Value `locationName:"arrayValues" type:"list"`

	// Long value
	BigIntValue *int64 `locationName:"bigIntValue" type:"long"`

	// Bit value
	BitValue *bool `locationName:"bitValue" type:"boolean"`

	// Blob value
	//
	// BlobValue is automatically base64 encoded/decoded by the SDK.
	BlobValue []byte `locationName:"blobValue" type:"blob"`

	// Double value
	DoubleValue *float64 `locationName:"doubleValue" type:"double"`

	// Integer value
	IntValue *int64 `locationName:"intValue" type:"integer"`

	// Is column null
	IsNull *bool `locationName:"isNull" type:"boolean"`

	// Float value
	RealValue *float64 `locationName:"realValue" type:"float"`

	// String value
	StringValue *string `locationName:"stringValue" type:"string"`

	// Struct or UDT
	StructValue *StructValue `locationName:"structValue" type:"structure"`
	// contains filtered or unexported fields
}

Column value Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-data-2018-08-01/Value

func (Value) GoString

func (s Value) GoString() string

GoString returns the string representation

func (Value) MarshalFields

func (s Value) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Value) String

func (s Value) String() string

String returns the string representation

Directories

Path Synopsis
Package rdsdataserviceiface provides an interface to enable mocking the AWS RDS DataService service client for testing your code.
Package rdsdataserviceiface provides an interface to enable mocking the AWS RDS DataService service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL