Smaws_Client_RedshiftData (smaws-clients.Smaws_Client

Types

module Types : sig ... end

Builders

val make_table_member : 
  ?schema:Types.string_ ->
  ?type_:Types.string_ ->
  ?name:Types.string_ ->
  unit ->
  Types.table_member

val make_sub_statement_data : 
  ?has_result_set:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?redshift_query_id:Types.long ->
  ?result_size:Types.long ->
  ?result_rows:Types.long ->
  ?query_string:Types.statement_string ->
  ?updated_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  ?created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  ?status:Types.statement_status_string ->
  ?error:Types.string_ ->
  ?duration:Types.long ->
  id:Types.uui_d ->
  unit ->
  Types.sub_statement_data

val make_sql_parameter : 
  value:Types.parameter_value ->
  name:Types.parameter_name ->
  unit ->
  Types.sql_parameter

val make_statement_data : 
  ?session_id:Types.uui_d ->
  ?result_format:Types.result_format_string ->
  ?is_batch_statement:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?query_parameters:Types.sql_parameters_list ->
  ?updated_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  ?created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  ?statement_name:Types.statement_name_string ->
  ?status:Types.status_string ->
  ?secret_arn:Types.secret_arn ->
  ?query_strings:Types.statement_string_list ->
  ?query_string:Types.statement_string ->
  id:Types.uui_d ->
  unit ->
  Types.statement_data

val make_list_tables_response : 
  ?next_token:Types.string_ ->
  ?tables:Types.table_list ->
  unit ->
  Types.list_tables_response

val make_list_tables_request : 
  ?workgroup_name:Types.workgroup_name_string ->
  ?max_results:Types.page_size ->
  ?next_token:Types.string_ ->
  ?table_pattern:Types.string_ ->
  ?schema_pattern:Types.string_ ->
  ?connected_database:Types.string_ ->
  ?db_user:Types.string_ ->
  ?secret_arn:Types.secret_arn ->
  ?cluster_identifier:Types.cluster_identifier_string ->
  database:Types.string_ ->
  unit ->
  Types.list_tables_request

val make_list_statements_response : 
  ?next_token:Types.string_ ->
  statements:Types.statement_list ->
  unit ->
  Types.list_statements_response

val make_list_statements_request : 
  ?workgroup_name:Types.workgroup_name_string ->
  ?cluster_identifier:Types.cluster_identifier_string ->
  ?database:Types.string_ ->
  ?role_level:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?status:Types.status_string ->
  ?statement_name:Types.statement_name_string ->
  ?max_results:Types.list_statements_limit ->
  ?next_token:Types.string_ ->
  unit ->
  Types.list_statements_request

val make_list_schemas_response : 
  ?next_token:Types.string_ ->
  ?schemas:Types.schema_list ->
  unit ->
  Types.list_schemas_response

val make_list_schemas_request : 
  ?workgroup_name:Types.workgroup_name_string ->
  ?max_results:Types.page_size ->
  ?next_token:Types.string_ ->
  ?schema_pattern:Types.string_ ->
  ?connected_database:Types.string_ ->
  ?db_user:Types.string_ ->
  ?secret_arn:Types.secret_arn ->
  ?cluster_identifier:Types.cluster_identifier_string ->
  database:Types.string_ ->
  unit ->
  Types.list_schemas_request

val make_list_databases_response : 
  ?next_token:Types.string_ ->
  ?databases:Types.database_list ->
  unit ->
  Types.list_databases_response

val make_list_databases_request : 
  ?workgroup_name:Types.workgroup_name_string ->
  ?max_results:Types.page_size ->
  ?next_token:Types.string_ ->
  ?db_user:Types.string_ ->
  ?secret_arn:Types.secret_arn ->
  ?cluster_identifier:Types.cluster_identifier_string ->
  database:Types.string_ ->
  unit ->
  Types.list_databases_request

val make_column_metadata : 
  ?column_default:Types.string_ ->
  ?length:Types.integer ->
  ?type_name:Types.string_ ->
  ?table_name:Types.string_ ->
  ?schema_name:Types.string_ ->
  ?scale:Types.integer ->
  ?precision:Types.integer ->
  ?nullable:Types.integer ->
  ?name:Types.string_ ->
  ?label:Types.string_ ->
  ?is_signed:Types.bool_ ->
  ?is_currency:Types.bool_ ->
  ?is_case_sensitive:Types.bool_ ->
  unit ->
  Types.column_metadata

val make_get_statement_result_v2_response : 
  ?next_token:Types.string_ ->
  ?result_format:Types.result_format_string ->
  ?total_num_rows:Types.long ->
  ?column_metadata:Types.column_metadata_list ->
  records:Types.formatted_sql_records ->
  unit ->
  Types.get_statement_result_v2_response

val make_get_statement_result_v2_request : 
  ?next_token:Types.string_ ->
  id:Types.uui_d ->
  unit ->
  Types.get_statement_result_v2_request

val make_get_statement_result_response : 
  ?next_token:Types.string_ ->
  ?total_num_rows:Types.long ->
  ?column_metadata:Types.column_metadata_list ->
  records:Types.sql_records ->
  unit ->
  Types.get_statement_result_response

val make_get_statement_result_request : 
  ?next_token:Types.string_ ->
  id:Types.uui_d ->
  unit ->
  Types.get_statement_result_request

val make_execute_statement_output : 
  ?session_id:Types.uui_d ->
  ?workgroup_name:Types.workgroup_name_string ->
  ?secret_arn:Types.secret_arn ->
  ?database:Types.string_ ->
  ?db_groups:Types.db_group_list ->
  ?db_user:Types.string_ ->
  ?cluster_identifier:Types.cluster_identifier_string ->
  ?created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  ?id:Types.uui_d ->
  unit ->
  Types.execute_statement_output

val make_execute_statement_input : 
  ?session_id:Types.uui_d ->
  ?session_keep_alive_seconds:Types.session_alive_seconds ->
  ?result_format:Types.result_format_string ->
  ?client_token:Types.client_token ->
  ?workgroup_name:Types.workgroup_name_string ->
  ?parameters:Types.sql_parameters_list ->
  ?statement_name:Types.statement_name_string ->
  ?with_event:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?database:Types.string_ ->
  ?db_user:Types.string_ ->
  ?secret_arn:Types.secret_arn ->
  ?cluster_identifier:Types.cluster_identifier_string ->
  sql:Types.statement_string ->
  unit ->
  Types.execute_statement_input

val make_describe_table_response : 
  ?next_token:Types.string_ ->
  ?column_list:Types.column_list ->
  ?table_name:Types.string_ ->
  unit ->
  Types.describe_table_response

val make_describe_table_request : 
  ?workgroup_name:Types.workgroup_name_string ->
  ?max_results:Types.page_size ->
  ?next_token:Types.string_ ->
  ?table:Types.string_ ->
  ?schema:Types.string_ ->
  ?connected_database:Types.string_ ->
  ?db_user:Types.string_ ->
  ?secret_arn:Types.secret_arn ->
  ?cluster_identifier:Types.cluster_identifier_string ->
  database:Types.string_ ->
  unit ->
  Types.describe_table_request

val make_describe_statement_response : 
  ?session_id:Types.string_ ->
  ?result_format:Types.result_format_string ->
  ?workgroup_name:Types.workgroup_name_string ->
  ?sub_statements:Types.sub_statement_list ->
  ?query_parameters:Types.sql_parameters_list ->
  ?redshift_query_id:Types.long ->
  ?result_size:Types.long ->
  ?result_rows:Types.long ->
  ?query_string:Types.statement_string ->
  ?has_result_set:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?redshift_pid:Types.long ->
  ?updated_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  ?created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  ?status:Types.status_string ->
  ?error:Types.string_ ->
  ?duration:Types.long ->
  ?cluster_identifier:Types.string_ ->
  ?database:Types.string_ ->
  ?db_user:Types.string_ ->
  ?secret_arn:Types.secret_arn ->
  id:Types.uui_d ->
  unit ->
  Types.describe_statement_response

val make_describe_statement_request : 
  id:Types.uui_d ->
  unit ->
  Types.describe_statement_request

val make_cancel_statement_response : 
  ?status:Smaws_Lib.Smithy_api.Types.boolean_ ->
  unit ->
  Types.cancel_statement_response

val make_cancel_statement_request : 
  id:Types.uui_d ->
  unit ->
  Types.cancel_statement_request

val make_batch_execute_statement_output : 
  ?session_id:Types.uui_d ->
  ?workgroup_name:Types.workgroup_name_string ->
  ?secret_arn:Types.secret_arn ->
  ?database:Types.string_ ->
  ?db_groups:Types.db_group_list ->
  ?db_user:Types.string_ ->
  ?cluster_identifier:Types.cluster_identifier_string ->
  ?created_at:Smaws_Lib.Smithy_api.Types.timestamp ->
  ?id:Types.uui_d ->
  unit ->
  Types.batch_execute_statement_output

val make_batch_execute_statement_input : 
  ?session_id:Types.uui_d ->
  ?session_keep_alive_seconds:Types.session_alive_seconds ->
  ?result_format:Types.result_format_string ->
  ?client_token:Types.client_token ->
  ?workgroup_name:Types.workgroup_name_string ->
  ?parameters:Types.sql_parameters_list ->
  ?statement_name:Types.statement_name_string ->
  ?with_event:Smaws_Lib.Smithy_api.Types.boolean_ ->
  ?database:Types.string_ ->
  ?db_user:Types.string_ ->
  ?secret_arn:Types.secret_arn ->
  ?cluster_identifier:Types.cluster_identifier_string ->
  sqls:Types.sql_list ->
  unit ->
  Types.batch_execute_statement_input

Operations

module BatchExecuteStatement : sig ... end

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

module CancelStatement : sig ... end

Cancels a running query. To be canceled, a query must be running.

module DescribeStatement : sig ... end

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.

module DescribeTable : sig ... end

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

module ExecuteStatement : sig ... end

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

module GetStatementResult : sig ... end

Fetches the temporarily cached result of an SQL statement in JSON format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement must have specified ResultFormat as JSON , or let the format default to JSON. A token is returned to page through the statement results.

module GetStatementResultV2 : sig ... end

Fetches the temporarily cached result of an SQL statement in CSV format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement must have specified ResultFormat as CSV. A token is returned to page through the statement results.

module ListDatabases : sig ... end

List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

module ListSchemas : sig ... end

Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:

module ListStatements : sig ... end

List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

module ListTables : sig ... end

module Json_serializers : sig ... end

module Json_deserializers : sig ... end