iter_describe_table `async` ¶

iter_describe_table(
    database: String,
    *,
    config_overrides: Optional[AsyncRedshiftDataClientConfig] = None,
    cluster_identifier: Optional[ClusterIdentifierString] = None,
    secret_arn: Optional[SecretArn] = None,
    db_user: Optional[String] = None,
    connected_database: Optional[String] = None,
    schema: Optional[String] = None,
    table: Optional[String] = None,
    next_token: Optional[String] = None,
    max_results: Optional[PageSize] = None,
    workgroup_name: Optional[WorkgroupNameString] = None,
) -> AsyncIterator[ColumnMetadata]

Source code in docs_src/capo_redshift_data/_services/async_redshift_data.py

async def iter_describe_table(
    self,
    database: "capo_redshift_data.types.string.String",
    *,
    config_overrides: Optional[AsyncRedshiftDataClientConfig] = None,
    cluster_identifier: Optional[
        "capo_redshift_data.types.cluster_identifier_string.ClusterIdentifierString"
    ] = None,
    secret_arn: Optional["capo_redshift_data.types.secret_arn.SecretArn"] = None,
    db_user: Optional["capo_redshift_data.types.string.String"] = None,
    connected_database: Optional["capo_redshift_data.types.string.String"] = None,
    schema: Optional["capo_redshift_data.types.string.String"] = None,
    table: Optional["capo_redshift_data.types.string.String"] = None,
    next_token: Optional["capo_redshift_data.types.string.String"] = None,
    max_results: Optional["capo_redshift_data.types.page_size.PageSize"] = None,
    workgroup_name: Optional[
        "capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
    ] = None,
) -> "AsyncIterator[capo_redshift_data.types.column_metadata.ColumnMetadata]":
    _token = next_token
    while True:
        _response = await self.describe_table(
            database,
            config_overrides=config_overrides,
            cluster_identifier=cluster_identifier,
            secret_arn=secret_arn,
            db_user=db_user,
            connected_database=connected_database,
            schema=schema,
            table=table,
            next_token=_token,
            max_results=max_results,
            workgroup_name=workgroup_name,
        )
        _page = _resolve_path(_response, ("column_list",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break

iter_describe_table async ¶

iter_describe_table `async` ¶