redshiftdataapiservice_list_tables: List the tables in a database
In paws.database: 'Amazon Web Services' Database Services

View source: R/redshiftdataapiservice_operations.R

redshiftdataapiservice_list_tables

R Documentation

List the tables in a database

Description

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:

See https://www.paws-r-sdk.com/docs/redshiftdataapiservice_list_tables/ for full documentation.

Usage

redshiftdataapiservice_list_tables(
  ClusterIdentifier = NULL,
  ConnectedDatabase = NULL,
  Database,
  DbUser = NULL,
  MaxResults = NULL,
  NextToken = NULL,
  SchemaPattern = NULL,
  SecretArn = NULL,
  TablePattern = NULL,
  WorkgroupName = NULL
)

Arguments

`ClusterIdentifier`	The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
`ConnectedDatabase`	A database name. The connected database is specified when you connect with your authentication credentials.
`Database`	[required] The name of the database that contains the tables to list. If `ConnectedDatabase` is not specified, this is also the database to connect to with your authentication credentials.
`DbUser`	The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
`MaxResults`	The maximum number of tables to return in the response. If more tables exist than fit in one response, then `NextToken` is returned to page through the results.
`NextToken`	A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
`SchemaPattern`	A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If `SchemaPattern` is not specified, then all tables that match `TablePattern` are returned. If neither `SchemaPattern` or `TablePattern` are specified, then all tables are returned.
`SecretArn`	The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
`TablePattern`	A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If `TablePattern` is not specified, then all tables that match `SchemaPattern`are returned. If neither `SchemaPattern` or `TablePattern` are specified, then all tables are returned.
`WorkgroupName`	The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.