/
Catalog Commands

Catalog Commands

Owned by Shaun Morris
Last updated: May 24, 2013Version comment

Catalog Commands

Title

Namespace

Description

DDF:: Catalog :: Core :: Commands

catalog

The Catalog Shell Commands are meant to be used with any CatalogProvider implementations. They provide general useful queries and functions against the Catalog API that can be used for debugging, printing, or scripting.

Most of commands can bypass the Catalog Framework and interact directly with the Catalog Provider if given the -p option if available. Hence no pre/post plugins are executed and no message validation is done if the provider (-p) option is used.

Catalog Commands

catalog:describe     catalog:dump         catalog:envlist      catalog:ingest       catalog:inspect      
catalog:latest       catalog:range        catalog:remove       catalog:removeall    catalog:search       
catalog:spatial

Command Descriptions

CommandDescription
describe
Provides a basic description of the Catalog implementation.
dump
Exports Metacards from the local Catalog. Does not remove them.
envlist
Provides a list of environment variables.
ingest
Ingests data files into the Catalog.
inspect
Provides the various fields of a Metacard for inspection.
latest
Retrieves the latest records from the Catalog based on Metacard.MODIFIED date.
range
Searches by the given range arguments (exclusively).
remove
Deletes a record from the local Catalog.
removeall
Attempts to delete all records from the local Catalog.
search
Searches records in the local Catalog.
spatial
Searches spatially the local Catalog.

Listing Available System Console Commands

To get a list of commands, type in the namespace of the desired extension and press <tab>.


For example, type in: catalog, then <tab>

Getting Help for a System Console Command

For details on any command type help and then the command. For example, help search

Example Help

ddf@local>help search
DESCRIPTION
        catalog:search
        Searches records in the catalog provider.
SYNTAX
        catalog:search [options] SEARCH_PHRASE [NUMBER_OF_ITEMS]
ARGUMENTS
        SEARCH_PHRASE
                Phrase to query the catalog provider.
        NUMBER_OF_ITEMS
                Number of maximum records to display.
                (defaults to -1)
OPTIONS
        --help
                Display this help message
        case-sensitive, -c
                Makes the search case sensitive
        -p, -provider
                Interacts with the provider directly instead of the framework.


The help command provides a description of the provided command, along with the syntax in how to use it, arguments it accepts, and available options.

Known Command Issues

Description

Ingest more than 200,000 data files stored NFS shares may cause Java Heap Space error . Linux only issue.

This is an NFS bug where it creates duplicate entries for some files when doing a file list.  Depend on the OS,  some Linux machines can handle the bug better and able get a list of files but get an incorrect number of files. Others would have a Java Heap Space error because there are too many file to list.

Ingest millions of complicated data into Solr can cause Java Heap Space error.

Complicated data has spatial types and large text.

Ingest serialized data file with scientific notation in WKT string causes RuntimeException

WKT string with scientific notation such as POINT (-34.8932113039107 -4.77974239601E-5) won't ingest.  This happens with serialized data format only.