Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

asrch is a command-line tool used to search an optional on-site installation of SOLR and extract data either in SOLR response format or complete CLAIMS Direct XML. It is installed as part of the CLAIMS Direct repository. Please see the Client Tools Installation Instructions for more information about how to install this tool.

...

Detailed Description of the Parameters

Connectivity

Parameter

Description
pgdbnameAs configured in /etc/alexandria.xml, the database entry pointing to the on-site CLAIMS Direct PostgreSQL instance. The default value is alexandria as this value is pre-configured in /etc/alexandria.xml.
urlThis is the URL of the CLAIMS Direct SOLR instance.

Output Options

The following parameters specify output possibilities.

ParameterDescription
outputOutput results to named file. The default output goes to stdout.
archiveArchive results in a predictable path structure. See aext.
archiverootThe root directory of the archive. See aext.
wrapperDefault top-level XML element. The default is patent-document.
prettyIndent the output XML.
countOnly output the count of documents.
maxrowsMaximum number of documents to output. If using the --table option, this parameter is ignored.
table

If specified, a table of UCIDs/publication_ids is created.

rawThis parameter specifies SOLR response XML as format.

SOLR Options

ParameterDescription
solropt

Raw SOLR query parameters. This parameter can be used multiple times, e.g.,


--solropt='sort=pd desc' --solropt='fq=pnctry:us'

Examples

Search and Count Results

...