local catalog
- Last UpdatedMar 27, 2025
- 5 minute read
The OLP CLI supports the following:
- list all local catalogs
- create a local catalog
- update a local catalog
- show a local catalog
- delete a local catalog
- list dependencies of a local catalog
- inspect a local catalog
local catalog list
Lists all local catalogs and returns a catalog name on a separate line.
To get more information about a catalog, see the olp local catalog show
command.
Optional parameters:
[filter]
Freeform text used to filter the catalog list. The filter checks if the catalog HRN contains thefilter
string.--json
Displays the command result in JSON format.--quiet
Displays catalog HRNs, each on a new line.
Example with filtering:
Output:
Example without filtering:
Output:
local catalog create
Creates an empty local catalog.
Required parameters:
<catalog ID>
The ID that is used as a hint to create the catalog HRN.<catalog name>
The human-readable name of the catalog. Overrides any values provided with the--config
parameter through the command line.--description <catalog description>
A detailed description of the catalog and its contents. Enclose the description in quotes.--summary <catalog summary>
A one-line summary of the catalog contents. Overrides any values provided with the--config
parameter through the command line.
Note
You can also specify the summary for a catalog through a configuration file referenced by the
--config
option.
Optional parameters:
--config <path to config file>
The path and name of the configuration file.--tags <tag1 tag2 ...>
Catalog keywords used for search discovery.--json
Displays the catalog HRN in JSON format.--quiet
Displays the catalog HRN.
Example:
The command below creates the empty local catalog first-catalog-example
, and displays the catalog's HRN in the output. To pass multiple arguments to a parameter that accepts them, separate the arguments with spaces.
Output:
Example:
The command below creates an empty local catalog second-catalog-example
with two tags (tag1
and tag2
) in the platform and displays the catalog's HRN in the console output.
Output:
local catalog update
Updates an existing local catalog with the configuration specified in a configuration file.
Warning
Catalog configuration changes
Like in the platform, you are not allowed to change a local catalog's layer configuration.
Required parameters:
<catalog HRN>
The HRN of the catalog.
Optional parameters:
--config <path to config file>
The path of the file with the updated configuration.--name <catalog name>
The human-readable name of the catalog. Overrides values provided with--config
through the command line.--summary <catalog summary>
A one-line summary of the catalog contents. Overrides values provided with--config
through the command line.--description <catalog description>
A detailed description of the catalog and its contents. Enclose the description in quotes.--tags <tag1 tag2 ...>
Catalog keywords used for search discovery. To unset tags, use--tags []
.--quiet
Displays empty output with no additional information.
Example:
Example configuration for a catalog with a volatile layer:
Example configuration for a catalog with a versioned layer:
Example configuration for a catalog with a stream layer:
Output:
Example with additional parameters:
Output:
For more information on catalog configurations, see Data API.
local catalog show
Shows the local catalog configuration.
Required parameters:
<catalog HRN>
The HRN of the catalog
Optional parameters:
--json
Displays the command result in JSON format.--quiet
Displays catalog's layer types and layer IDs, separated by space.
Example:
Output:
local catalog delete
Deletes a local catalog from your filesystem.
Warning
Deleting local catalogs
This command removes the local catalog completely; it cannot be restored.
Required parameters:
<catalog HRN>
The HRN of the catalog.
Optional parameters:
--quiet
Displays empty output with no additional information.
Example:
Output:
local catalog dependency list
Lists all catalog dependencies for a specific version.
Required parameters:
<catalog HRN>
The HRN of the catalog.
Optional parameters:
--version <catalog version>
The catalog version. The default value is the latest version.--direct-only
When enabled, only direct dependencies are displayed. When disabled, both direct and indirect dependencies are displayed. Disabled by default.--json
Displays the command result in JSON format.--quiet
Displays HRNs of catalog dependencies, each on a new line.
Example:
The command below lists all direct dependencies for the hrn:local:data:::first-catalog-example-id
catalog in JSON format.
Output:
local catalog inspect
Opens the local Data Inspector in an external browser. The command fails if the local catalog does not exist.
To inspect a specific layer, see the olp local catalog layer inspect
command.
Optional parameters:
--quiet
Displays empty output with no additional information.
Note
The
olp local catalog inspect
command starts a local Data API server and does not return control to the user until the process is killed.
Example:
The command below opens an external browser and navigates to the hrn:local:data:::first-catalog-example-id
catalog overview page in the platform portal.
Output: