| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Glue.SearchTables
Description
Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.
You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.
Synopsis
- data SearchTables = SearchTables' {}
- newSearchTables :: SearchTables
- searchTables_resourceShareType :: Lens' SearchTables (Maybe ResourceShareType)
- searchTables_searchText :: Lens' SearchTables (Maybe Text)
- searchTables_filters :: Lens' SearchTables (Maybe [PropertyPredicate])
- searchTables_catalogId :: Lens' SearchTables (Maybe Text)
- searchTables_sortCriteria :: Lens' SearchTables (Maybe [SortCriterion])
- searchTables_nextToken :: Lens' SearchTables (Maybe Text)
- searchTables_maxResults :: Lens' SearchTables (Maybe Natural)
- data SearchTablesResponse = SearchTablesResponse' {}
- newSearchTablesResponse :: Int -> SearchTablesResponse
- searchTablesResponse_tableList :: Lens' SearchTablesResponse (Maybe [Table])
- searchTablesResponse_nextToken :: Lens' SearchTablesResponse (Maybe Text)
- searchTablesResponse_httpStatus :: Lens' SearchTablesResponse Int
Creating a Request
data SearchTables Source #
See: newSearchTables smart constructor.
Constructors
| SearchTables' | |
Fields
| |
Instances
newSearchTables :: SearchTables Source #
Create a value of SearchTables with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceShareType:SearchTables', searchTables_resourceShareType - Allows you to specify that you want to search the tables shared with
your account. The allowable values are FOREIGN or ALL.
- If set to
FOREIGN, will search the tables shared with your account. - If set to
ALL, will search the tables shared with your account, as well as the tables in yor local account.
$sel:searchText:SearchTables', searchTables_searchText - A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
$sel:filters:SearchTables', searchTables_filters - A list of key-value pairs, and a comparator used to filter the search
results. Returns all entities matching the predicate.
The Comparator member of the PropertyPredicate struct is used only
for time fields, and can be omitted for other field types. Also, when
comparing string values, such as when Key=Name, a fuzzy match
algorithm is used. The Key field (for example, the value of the Name
field) is split on certain punctuation characters, for example, -, :, #,
etc. into tokens. Then each token is exact-match compared with the
Value member of PropertyPredicate. For example, if Key=Name and
Value=link, tables named customer-link and xx-link-yy are
returned, but xxlinkyy is not returned.
$sel:catalogId:SearchTables', searchTables_catalogId - A unique identifier, consisting of account_id .
$sel:sortCriteria:SearchTables', searchTables_sortCriteria - A list of criteria for sorting the results by a field name, in an
ascending or descending order.
$sel:nextToken:SearchTables', searchTables_nextToken - A continuation token, included if this is a continuation call.
$sel:maxResults:SearchTables', searchTables_maxResults - The maximum number of tables to return in a single response.
Request Lenses
searchTables_resourceShareType :: Lens' SearchTables (Maybe ResourceShareType) Source #
Allows you to specify that you want to search the tables shared with
your account. The allowable values are FOREIGN or ALL.
- If set to
FOREIGN, will search the tables shared with your account. - If set to
ALL, will search the tables shared with your account, as well as the tables in yor local account.
searchTables_searchText :: Lens' SearchTables (Maybe Text) Source #
A string used for a text search.
Specifying a value in quotes filters based on an exact match to the value.
searchTables_filters :: Lens' SearchTables (Maybe [PropertyPredicate]) Source #
A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.
The Comparator member of the PropertyPredicate struct is used only
for time fields, and can be omitted for other field types. Also, when
comparing string values, such as when Key=Name, a fuzzy match
algorithm is used. The Key field (for example, the value of the Name
field) is split on certain punctuation characters, for example, -, :, #,
etc. into tokens. Then each token is exact-match compared with the
Value member of PropertyPredicate. For example, if Key=Name and
Value=link, tables named customer-link and xx-link-yy are
returned, but xxlinkyy is not returned.
searchTables_catalogId :: Lens' SearchTables (Maybe Text) Source #
A unique identifier, consisting of account_id .
searchTables_sortCriteria :: Lens' SearchTables (Maybe [SortCriterion]) Source #
A list of criteria for sorting the results by a field name, in an ascending or descending order.
searchTables_nextToken :: Lens' SearchTables (Maybe Text) Source #
A continuation token, included if this is a continuation call.
searchTables_maxResults :: Lens' SearchTables (Maybe Natural) Source #
The maximum number of tables to return in a single response.
Destructuring the Response
data SearchTablesResponse Source #
See: newSearchTablesResponse smart constructor.
Constructors
| SearchTablesResponse' | |
Instances
newSearchTablesResponse Source #
Arguments
| :: Int | |
| -> SearchTablesResponse |
Create a value of SearchTablesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tableList:SearchTablesResponse', searchTablesResponse_tableList - A list of the requested Table objects. The SearchTables response
returns only the tables that you have access to.
$sel:nextToken:SearchTables', searchTablesResponse_nextToken - A continuation token, present if the current list segment is not the
last.
$sel:httpStatus:SearchTablesResponse', searchTablesResponse_httpStatus - The response's http status code.
Response Lenses
searchTablesResponse_tableList :: Lens' SearchTablesResponse (Maybe [Table]) Source #
A list of the requested Table objects. The SearchTables response
returns only the tables that you have access to.
searchTablesResponse_nextToken :: Lens' SearchTablesResponse (Maybe Text) Source #
A continuation token, present if the current list segment is not the last.
searchTablesResponse_httpStatus :: Lens' SearchTablesResponse Int Source #
The response's http status code.