1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package athena 4 5import ( 6 "context" 7 "fmt" 8 awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware" 9 "github.com/aws/aws-sdk-go-v2/aws/signer/v4" 10 "github.com/aws/aws-sdk-go-v2/service/athena/types" 11 "github.com/aws/smithy-go/middleware" 12 smithyhttp "github.com/aws/smithy-go/transport/http" 13) 14 15// Lists the metadata for the tables in the specified data catalog database. 16func (c *Client) ListTableMetadata(ctx context.Context, params *ListTableMetadataInput, optFns ...func(*Options)) (*ListTableMetadataOutput, error) { 17 if params == nil { 18 params = &ListTableMetadataInput{} 19 } 20 21 result, metadata, err := c.invokeOperation(ctx, "ListTableMetadata", params, optFns, addOperationListTableMetadataMiddlewares) 22 if err != nil { 23 return nil, err 24 } 25 26 out := result.(*ListTableMetadataOutput) 27 out.ResultMetadata = metadata 28 return out, nil 29} 30 31type ListTableMetadataInput struct { 32 33 // The name of the data catalog for which table metadata should be returned. 34 // 35 // This member is required. 36 CatalogName *string 37 38 // The name of the database for which table metadata should be returned. 39 // 40 // This member is required. 41 DatabaseName *string 42 43 // A regex filter that pattern-matches table names. If no expression is supplied, 44 // metadata for all tables are listed. 45 Expression *string 46 47 // Specifies the maximum number of results to return. 48 MaxResults *int32 49 50 // A token generated by the Athena service that specifies where to continue 51 // pagination if a previous request was truncated. To obtain the next set of pages, 52 // pass in the NextToken from the response object of the previous page call. 53 NextToken *string 54} 55 56type ListTableMetadataOutput struct { 57 58 // A token generated by the Athena service that specifies where to continue 59 // pagination if a previous request was truncated. To obtain the next set of pages, 60 // pass in the NextToken from the response object of the previous page call. 61 NextToken *string 62 63 // A list of table metadata. 64 TableMetadataList []types.TableMetadata 65 66 // Metadata pertaining to the operation's result. 67 ResultMetadata middleware.Metadata 68} 69 70func addOperationListTableMetadataMiddlewares(stack *middleware.Stack, options Options) (err error) { 71 err = stack.Serialize.Add(&awsAwsjson11_serializeOpListTableMetadata{}, middleware.After) 72 if err != nil { 73 return err 74 } 75 err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpListTableMetadata{}, middleware.After) 76 if err != nil { 77 return err 78 } 79 if err = addSetLoggerMiddleware(stack, options); err != nil { 80 return err 81 } 82 if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil { 83 return err 84 } 85 if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil { 86 return err 87 } 88 if err = addResolveEndpointMiddleware(stack, options); err != nil { 89 return err 90 } 91 if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil { 92 return err 93 } 94 if err = addRetryMiddlewares(stack, options); err != nil { 95 return err 96 } 97 if err = addHTTPSignerV4Middleware(stack, options); err != nil { 98 return err 99 } 100 if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil { 101 return err 102 } 103 if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil { 104 return err 105 } 106 if err = addClientUserAgent(stack); err != nil { 107 return err 108 } 109 if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil { 110 return err 111 } 112 if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil { 113 return err 114 } 115 if err = addOpListTableMetadataValidationMiddleware(stack); err != nil { 116 return err 117 } 118 if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListTableMetadata(options.Region), middleware.Before); err != nil { 119 return err 120 } 121 if err = addRequestIDRetrieverMiddleware(stack); err != nil { 122 return err 123 } 124 if err = addResponseErrorMiddleware(stack); err != nil { 125 return err 126 } 127 if err = addRequestResponseLogging(stack, options); err != nil { 128 return err 129 } 130 return nil 131} 132 133// ListTableMetadataAPIClient is a client that implements the ListTableMetadata 134// operation. 135type ListTableMetadataAPIClient interface { 136 ListTableMetadata(context.Context, *ListTableMetadataInput, ...func(*Options)) (*ListTableMetadataOutput, error) 137} 138 139var _ ListTableMetadataAPIClient = (*Client)(nil) 140 141// ListTableMetadataPaginatorOptions is the paginator options for ListTableMetadata 142type ListTableMetadataPaginatorOptions struct { 143 // Specifies the maximum number of results to return. 144 Limit int32 145 146 // Set to true if pagination should stop if the service returns a pagination token 147 // that matches the most recent token provided to the service. 148 StopOnDuplicateToken bool 149} 150 151// ListTableMetadataPaginator is a paginator for ListTableMetadata 152type ListTableMetadataPaginator struct { 153 options ListTableMetadataPaginatorOptions 154 client ListTableMetadataAPIClient 155 params *ListTableMetadataInput 156 nextToken *string 157 firstPage bool 158} 159 160// NewListTableMetadataPaginator returns a new ListTableMetadataPaginator 161func NewListTableMetadataPaginator(client ListTableMetadataAPIClient, params *ListTableMetadataInput, optFns ...func(*ListTableMetadataPaginatorOptions)) *ListTableMetadataPaginator { 162 options := ListTableMetadataPaginatorOptions{} 163 if params.MaxResults != nil { 164 options.Limit = *params.MaxResults 165 } 166 167 for _, fn := range optFns { 168 fn(&options) 169 } 170 171 if params == nil { 172 params = &ListTableMetadataInput{} 173 } 174 175 return &ListTableMetadataPaginator{ 176 options: options, 177 client: client, 178 params: params, 179 firstPage: true, 180 } 181} 182 183// HasMorePages returns a boolean indicating whether more pages are available 184func (p *ListTableMetadataPaginator) HasMorePages() bool { 185 return p.firstPage || p.nextToken != nil 186} 187 188// NextPage retrieves the next ListTableMetadata page. 189func (p *ListTableMetadataPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTableMetadataOutput, error) { 190 if !p.HasMorePages() { 191 return nil, fmt.Errorf("no more pages available") 192 } 193 194 params := *p.params 195 params.NextToken = p.nextToken 196 197 var limit *int32 198 if p.options.Limit > 0 { 199 limit = &p.options.Limit 200 } 201 params.MaxResults = limit 202 203 result, err := p.client.ListTableMetadata(ctx, ¶ms, optFns...) 204 if err != nil { 205 return nil, err 206 } 207 p.firstPage = false 208 209 prevToken := p.nextToken 210 p.nextToken = result.NextToken 211 212 if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken { 213 p.nextToken = nil 214 } 215 216 return result, nil 217} 218 219func newServiceMetadataMiddleware_opListTableMetadata(region string) *awsmiddleware.RegisterServiceMetadata { 220 return &awsmiddleware.RegisterServiceMetadata{ 221 Region: region, 222 ServiceID: ServiceID, 223 SigningName: "athena", 224 OperationName: "ListTableMetadata", 225 } 226} 227