- NAME
-
- gcloud data-catalog search - search Data Catalog for resources that match a query
- SYNOPSIS
-
-
gcloud data-catalog searchQUERY(--include-gcp-public-datasets--include-organization-ids=[ORGANIZATION, …]--include-project-ids=[PROJECT, …]--restricted-locations=[LOCATION, …]) [--limit=LIMIT] [--order-by=ORDER_BY] [--page-size=PAGE_SIZE] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(DEPRECATED)This command is deprecated. Please usegcloud dataplex entries searchinstead.Search Data Catalog for resources that match a query.
- EXAMPLES
- To search project 'my-project' for Data Catalog resources that match the simple
predicate 'foo':
gcloud data-catalog search 'foo' --include-project-ids = my-projectTo search organization '1234' for Data Catalog resources that match entities whose names match the predicate 'foo':
gcloud data-catalog search 'name:foo' --include-organization-ids = 1234 - POSITIONAL ARGUMENTS
-
-
QUERY - Query string in search query syntax in Data Catalog. For more information, see: https://cloud.google.com/data-catalog/docs/how-to/search-reference
-
- REQUIRED FLAGS
-
- Scope. Control the scope of the search.
At least one of these must be specified:
-
--include-gcp-public-datasets - If True, include Google Cloud Platform public datasets in the search results.
-
--include-organization-ids=[ORGANIZATION,…] - List of Cloud Organization IDs to include in the search.
-
--include-project-ids=[PROJECT,…] - List of Cloud Project IDs to include in the search.
-
--restricted-locations=[LOCATION,…] - List of locations to search within.
-
- Scope. Control the scope of the search.
- LIST COMMAND FLAGS
-
-
--limit=LIMIT - Maximum number of resources to list. The default is
unlimited. -
--order-by=ORDER_BY - Specifies the ordering of results. Defaults to 'relevance'.
Currently supported case-sensitive choices are:
- relevance
- last_access_timestamp [asc|desc]: defaults to descending.
- last_modified_timestamp [asc|desc]: defaults to descending.
To order by last modified timestamp ascending, specify:
--order-by="last_modified_timestamp desc". -
--page-size=PAGE_SIZE - Some services group resource list output into pages. This flag specifies the maximum number of resources per page.
-
- GCLOUD WIDE FLAGS
- These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - NOTES
- These variants are also available:
gcloud alpha data-catalog searchgcloud beta data-catalog search
gcloud data-catalog search
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-27 UTC.
