Documentation

Overview

    Package rdsdata provides the API client, operations, and parameter types for AWS RDS DataService.

    Amazon RDS Data Service Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API. For more information about the Data Service API, see Using the Data API for Aurora Serverless (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the Amazon Aurora User Guide.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2018-08-01"
    View Source
    const ServiceID = "RDS Data"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type BatchExecuteStatementInput

          type BatchExecuteStatementInput struct {
          
          	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
          	//
          	// This member is required.
          	ResourceArn *string
          
          	// The name or ARN of the secret that enables access to the DB cluster.
          	//
          	// This member is required.
          	SecretArn *string
          
          	// The SQL statement to run.
          	//
          	// This member is required.
          	Sql *string
          
          	// The name of the database.
          	Database *string
          
          	// The parameter set for the batch operation. The SQL statement is executed as many
          	// times as the number of parameter sets provided. To execute a SQL statement with
          	// no parameters, use one of the following options:
          	//
          	// * Specify one or more empty
          	// parameter sets.
          	//
          	// * Use the ExecuteStatement operation instead of the
          	// BatchExecuteStatement operation.
          	//
          	// Array parameters are not supported.
          	ParameterSets [][]types.SqlParameter
          
          	// The name of the database schema.
          	Schema *string
          
          	// The identifier of a transaction that was started by using the BeginTransaction
          	// operation. Specify the transaction ID of the transaction that you want to
          	// include the SQL statement in. If the SQL statement is not part of a transaction,
          	// don't set this parameter.
          	TransactionId *string
          }

            The request parameters represent the input of a SQL statement over an array of data.

            type BatchExecuteStatementOutput

            type BatchExecuteStatementOutput struct {
            
            	// The execution results of each batch entry.
            	UpdateResults []types.UpdateResult
            
            	// Metadata pertaining to the operation's result.
            	ResultMetadata middleware.Metadata
            }

              The response elements represent the output of a SQL statement over an array of data.

              type BeginTransactionInput

              type BeginTransactionInput struct {
              
              	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
              	//
              	// This member is required.
              	ResourceArn *string
              
              	// The name or ARN of the secret that enables access to the DB cluster.
              	//
              	// This member is required.
              	SecretArn *string
              
              	// The name of the database.
              	Database *string
              
              	// The name of the database schema.
              	Schema *string
              }

                The request parameters represent the input of a request to start a SQL transaction.

                type BeginTransactionOutput

                type BeginTransactionOutput struct {
                
                	// The transaction ID of the transaction started by the call.
                	TransactionId *string
                
                	// Metadata pertaining to the operation's result.
                	ResultMetadata middleware.Metadata
                }

                  The response elements represent the output of a request to start a SQL transaction.

                  type Client

                  type Client struct {
                  	// contains filtered or unexported fields
                  }

                    Client provides the API client to make operations call for AWS RDS DataService.

                    func New

                    func New(options Options, optFns ...func(*Options)) *Client

                      New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

                      func NewFromConfig

                      func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                        NewFromConfig returns a new client from the provided config.

                        func (*Client) BatchExecuteStatement

                        func (c *Client) BatchExecuteStatement(ctx context.Context, params *BatchExecuteStatementInput, optFns ...func(*Options)) (*BatchExecuteStatementOutput, error)

                          Runs a batch SQL statement over an array of data. You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

                          func (*Client) BeginTransaction

                          func (c *Client) BeginTransaction(ctx context.Context, params *BeginTransactionInput, optFns ...func(*Options)) (*BeginTransactionOutput, error)

                            Starts a SQL transaction. A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours. A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically. DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate ExecuteStatement call with continueAfterTimeout enabled.

                            func (*Client) CommitTransaction

                            func (c *Client) CommitTransaction(ctx context.Context, params *CommitTransactionInput, optFns ...func(*Options)) (*CommitTransactionOutput, error)

                              Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

                              func (*Client) ExecuteSql

                              func (c *Client) ExecuteSql(ctx context.Context, params *ExecuteSqlInput, optFns ...func(*Options)) (*ExecuteSqlOutput, error)

                                Runs one or more SQL statements. This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

                                Deprecated: The ExecuteSql API is deprecated, please use the ExecuteStatement API.

                                func (*Client) ExecuteStatement

                                func (c *Client) ExecuteStatement(ctx context.Context, params *ExecuteStatementInput, optFns ...func(*Options)) (*ExecuteStatementOutput, error)

                                  Runs a SQL statement against a database. If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically. The response size limit is 1 MB. If the call returns more than 1 MB of response data, the call is terminated.

                                  func (*Client) RollbackTransaction

                                  func (c *Client) RollbackTransaction(ctx context.Context, params *RollbackTransactionInput, optFns ...func(*Options)) (*RollbackTransactionOutput, error)

                                    Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

                                    type CommitTransactionInput

                                    type CommitTransactionInput struct {
                                    
                                    	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
                                    	//
                                    	// This member is required.
                                    	ResourceArn *string
                                    
                                    	// The name or ARN of the secret that enables access to the DB cluster.
                                    	//
                                    	// This member is required.
                                    	SecretArn *string
                                    
                                    	// The identifier of the transaction to end and commit.
                                    	//
                                    	// This member is required.
                                    	TransactionId *string
                                    }

                                      The request parameters represent the input of a commit transaction request.

                                      type CommitTransactionOutput

                                      type CommitTransactionOutput struct {
                                      
                                      	// The status of the commit operation.
                                      	TransactionStatus *string
                                      
                                      	// Metadata pertaining to the operation's result.
                                      	ResultMetadata middleware.Metadata
                                      }

                                        The response elements represent the output of a commit transaction request.

                                        type EndpointResolver

                                        type EndpointResolver interface {
                                        	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                        }

                                          EndpointResolver interface for resolving service endpoints.

                                          func EndpointResolverFromURL

                                          func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                            EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                            type EndpointResolverFunc

                                            type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                              EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                              func (EndpointResolverFunc) ResolveEndpoint

                                              func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                              type EndpointResolverOptions

                                              type EndpointResolverOptions = internalendpoints.Options

                                                EndpointResolverOptions is the service endpoint resolver options

                                                type ExecuteSqlInput

                                                type ExecuteSqlInput struct {
                                                
                                                	// The Amazon Resource Name (ARN) of the secret that enables access to the DB
                                                	// cluster.
                                                	//
                                                	// This member is required.
                                                	AwsSecretStoreArn *string
                                                
                                                	// The ARN of the Aurora Serverless DB cluster.
                                                	//
                                                	// This member is required.
                                                	DbClusterOrInstanceArn *string
                                                
                                                	// One or more SQL statements to run on the DB cluster. You can separate SQL
                                                	// statements from each other with a semicolon (;). Any valid SQL statement is
                                                	// permitted, including data definition, data manipulation, and commit statements.
                                                	//
                                                	// This member is required.
                                                	SqlStatements *string
                                                
                                                	// The name of the database.
                                                	Database *string
                                                
                                                	// The name of the database schema.
                                                	Schema *string
                                                }

                                                  The request parameters represent the input of a request to run one or more SQL statements.

                                                  type ExecuteSqlOutput

                                                  type ExecuteSqlOutput struct {
                                                  
                                                  	// The results of the SQL statement or statements.
                                                  	SqlStatementResults []types.SqlStatementResult
                                                  
                                                  	// Metadata pertaining to the operation's result.
                                                  	ResultMetadata middleware.Metadata
                                                  }

                                                    The response elements represent the output of a request to run one or more SQL statements.

                                                    type ExecuteStatementInput

                                                    type ExecuteStatementInput struct {
                                                    
                                                    	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
                                                    	//
                                                    	// This member is required.
                                                    	ResourceArn *string
                                                    
                                                    	// The name or ARN of the secret that enables access to the DB cluster.
                                                    	//
                                                    	// This member is required.
                                                    	SecretArn *string
                                                    
                                                    	// The SQL statement to run.
                                                    	//
                                                    	// This member is required.
                                                    	Sql *string
                                                    
                                                    	// A value that indicates whether to continue running the statement after the call
                                                    	// times out. By default, the statement stops running when the call times out. For
                                                    	// DDL statements, we recommend continuing to run the statement after the call
                                                    	// times out. When a DDL statement terminates before it is finished running, it can
                                                    	// result in errors and possibly corrupted data structures.
                                                    	ContinueAfterTimeout bool
                                                    
                                                    	// The name of the database.
                                                    	Database *string
                                                    
                                                    	// A value that indicates whether to include metadata in the results.
                                                    	IncludeResultMetadata bool
                                                    
                                                    	// The parameters for the SQL statement. Array parameters are not supported.
                                                    	Parameters []types.SqlParameter
                                                    
                                                    	// Options that control how the result set is returned.
                                                    	ResultSetOptions *types.ResultSetOptions
                                                    
                                                    	// The name of the database schema. Currently, the schema parameter isn't
                                                    	// supported.
                                                    	Schema *string
                                                    
                                                    	// The identifier of a transaction that was started by using the BeginTransaction
                                                    	// operation. Specify the transaction ID of the transaction that you want to
                                                    	// include the SQL statement in. If the SQL statement is not part of a transaction,
                                                    	// don't set this parameter.
                                                    	TransactionId *string
                                                    }

                                                      The request parameters represent the input of a request to run a SQL statement against a database.

                                                      type ExecuteStatementOutput

                                                      type ExecuteStatementOutput struct {
                                                      
                                                      	// Metadata for the columns included in the results.
                                                      	ColumnMetadata []types.ColumnMetadata
                                                      
                                                      	// Values for fields generated during the request. The generatedFields data isn't
                                                      	// supported by Aurora PostgreSQL. To get the values of generated fields, use the
                                                      	// RETURNING clause. For more information, see Returning Data From Modified Rows
                                                      	// (https://www.postgresql.org/docs/10/dml-returning.html) in the PostgreSQL
                                                      	// documentation.
                                                      	GeneratedFields []types.Field
                                                      
                                                      	// The number of records updated by the request.
                                                      	NumberOfRecordsUpdated int64
                                                      
                                                      	// The records returned by the SQL statement.
                                                      	Records [][]types.Field
                                                      
                                                      	// Metadata pertaining to the operation's result.
                                                      	ResultMetadata middleware.Metadata
                                                      }

                                                        The response elements represent the output of a request to run a SQL statement against a database.

                                                        type HTTPClient

                                                        type HTTPClient interface {
                                                        	Do(*http.Request) (*http.Response, error)
                                                        }

                                                        type HTTPSignerV4

                                                        type HTTPSignerV4 interface {
                                                        	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                        }

                                                        type Options

                                                        type Options struct {
                                                        	// Set of options to modify how an operation is invoked. These apply to all
                                                        	// operations invoked for this client. Use functional options on operation call to
                                                        	// modify this list for per operation behavior.
                                                        	APIOptions []func(*middleware.Stack) error
                                                        
                                                        	// Configures the events that will be sent to the configured logger.
                                                        	ClientLogMode aws.ClientLogMode
                                                        
                                                        	// The credentials object to use when signing requests.
                                                        	Credentials aws.CredentialsProvider
                                                        
                                                        	// The endpoint options to be used when attempting to resolve an endpoint.
                                                        	EndpointOptions EndpointResolverOptions
                                                        
                                                        	// The service endpoint resolver.
                                                        	EndpointResolver EndpointResolver
                                                        
                                                        	// Signature Version 4 (SigV4) Signer
                                                        	HTTPSignerV4 HTTPSignerV4
                                                        
                                                        	// The logger writer interface to write logging messages to.
                                                        	Logger logging.Logger
                                                        
                                                        	// The region to send requests to. (Required)
                                                        	Region string
                                                        
                                                        	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                        	// failures. When nil the API client will use a default retryer.
                                                        	Retryer aws.Retryer
                                                        
                                                        	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                        	// implementation if nil.
                                                        	HTTPClient HTTPClient
                                                        }

                                                        func (Options) Copy

                                                        func (o Options) Copy() Options

                                                          Copy creates a clone where the APIOptions list is deep copied.

                                                          type ResolveEndpoint

                                                          type ResolveEndpoint struct {
                                                          	Resolver EndpointResolver
                                                          	Options  EndpointResolverOptions
                                                          }

                                                          func (*ResolveEndpoint) HandleSerialize

                                                          func (*ResolveEndpoint) ID

                                                          func (*ResolveEndpoint) ID() string

                                                          type RollbackTransactionInput

                                                          type RollbackTransactionInput struct {
                                                          
                                                          	// The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.
                                                          	//
                                                          	// This member is required.
                                                          	ResourceArn *string
                                                          
                                                          	// The name or ARN of the secret that enables access to the DB cluster.
                                                          	//
                                                          	// This member is required.
                                                          	SecretArn *string
                                                          
                                                          	// The identifier of the transaction to roll back.
                                                          	//
                                                          	// This member is required.
                                                          	TransactionId *string
                                                          }

                                                            The request parameters represent the input of a request to perform a rollback of a transaction.

                                                            type RollbackTransactionOutput

                                                            type RollbackTransactionOutput struct {
                                                            
                                                            	// The status of the rollback operation.
                                                            	TransactionStatus *string
                                                            
                                                            	// Metadata pertaining to the operation's result.
                                                            	ResultMetadata middleware.Metadata
                                                            }

                                                              The response elements represent the output of a request to perform a rollback of a transaction.

                                                              Directories

                                                              Path Synopsis
                                                              internal