Appendix - CloudView Console Commands

The CloudView console (short: CVConsole) is a command-line interface for CloudView administration and debugging.

When administration is possible using the MAMI, this is the preferred approach. When it is not, you can count on the CVConsole.

This page discusses:

See Also
Appendix - Deployment Roles and Related Processes
Appendix - CloudView Support Information

cvadmin

apps

generate

  • Create an archive file for the application you want to deploy.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    apps-file String File path for the application archive file
    include String Additional files or folders to include in your archive. Separate using semicolons.
    exclude String Files or folders to exclude from your archive. Separate using semicolons.
    debug boolean false Set to true to see more log information during the packaging process.
    toDirectory boolean false Export the application to a directory instead of an archive file.

install

  • Deploy an application on your instance. The instance must be running.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    apps-file (required) String Path to the application you want to install
    port Port Override port number variable.
    instance String Override instance name variable
    installdir File Override INSTALLDIR variable
    datadir File Override DATADIR variable
    hostname String Override hostname variable
    noversioncheck boolean false Disable version check
    propertyFile File File that contains variables mapping
    appIsDirectory boolean false If the app is provided as a directory instead of a zip file

installV6

  • Deploy an application on your instance in the DS V6 Installer context. The instance must be running.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    cvapps-dir (required) File Path to the application you want to install
    app-dir (required) File The app installation directory path (directory where the installerV6 installs the application)
    noversioncheck boolean false Disable version check
    propertyFile File File that contains variables mapping

box

force-crawl-url

  • Synchronously crawl a URL through a crawler.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    crawler (required) String Name of the crawler to submit the url to.
    url (required) String A url to submit.
    site String Consider this url belonging to this site.
    siteRoot boolean false Consider this url as a site.
    sitePostRedir String Consider this url belonging to this site.
    priority int 3 Which priority to give to this url. Fastest is 0, slowest is most likely 5 (check crawler configuration).
    group String In which group to crawl this url.

submit-urls

  • Submit urls to a crawler.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    crawler (required) String Name of the crawler to submit the url to.
    url (required) String[] (multivalued) A url to submit.
    site String Consider this url belonging to this site.
    siteRoot boolean false Consider this url as a site.
    sitePostRedir String Consider this url belonging to this site.
    priority int 3 Which priority to give to this url. Fastest is 0, slowest is most likely 5 (check crawler configuration).
    group String In which group to crawl this url.
    force boolean false Crawl even if the url has already been crawled.

connect

upgrade-config

  • Upgrade a connector configuration.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    name (required) String Name of a Java managed connector

indexing

attach-replica

  • Attach a replica to its builder.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup (required) BuildGroup Build group on which to act
    slice (required) Slice Slice on which to act
    instance (required) SliceInstance Instance on which to act

clear-replica

  • Clear a replica
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup (required) BuildGroup Build group on which to act
    slice (required) Slice Slice on which to act
    instance (required) SliceInstance Instance on which to act

detach-replica

  • Detach a replica from its builder.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup (required) BuildGroup Build group on which to act
    slice (required) Slice Slice on which to act
    instance (required) SliceInstance Instance on which to act

disable-analysis

  • Disable the analysis
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act

disable-import

  • Disable the import
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act

disable-pushapi

  • Disable the PushAPI
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act

enable-analysis

  • Enable the analysis
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act

enable-import

  • Enable the import
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act

enable-pushapi

  • Enable the PushAPI
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act

indexing-status

  • Retrieve the indexing status.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act

licensing

dump-users

  • Deprecated: use list-users instead.
  • This command is safe to use while CloudView is running.
  • No parameter.

list-users

  • Produce the list of active mashup users (session lasts for 30 days). These are the users that count against the users limit.
  • This command is safe to use while CloudView is running.
  • No parameter.

linguistic

compile-fastrules

  • Compile a FastRules XML resource file
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    tokenizationConfig TokenizationConfig tok0 Tokenization config to use
    input (required) File Fast rules definition file
    output (required) File Output directory

compile-features

  • Compile a FeaturesExtractor XML resource file
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    tokenizationConfig TokenizationConfig tok0 Tokenization config to use
    input (required) File Features definition file
    output (required) File Output directory

compile-ontology

  • Compile an Ontology XML resource file
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    tokenizationConfig TokenizationConfig tok0 Tokenization config to use
    input (required) File Ontology definition file
    output (required) File Output directory

compile-semantic-extractor

  • Compile a SemanticExtractor XML resource file
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    tokenizationConfig TokenizationConfig tok0 Tokenization config to use
    input (required) File XML definition file
    output (required) File Output directory

compile-synonyms

  • Compile a Synonyms XML file
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    tokenizationConfig TokenizationConfig tok0 Tokenization config to use
    input (required) File Synonyms definition file
    output (required) File Output directory

convert-ontology-from-skos-to-xml

  • Convert a SKOS file to an ontology resource.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    input (required) File Input file
    useAltLabels boolean true Use skos:altLabels properties
    useHiddenLabels boolean true Use skos:hiddenLabels properties
    hierarchicalEntries boolean true Generate hierarchical display forms
    annotation (required) String Root annotation to generate
    useBroaders boolean true Use skos:broader properties
    output (required) File Output file

convert-ontology-from-xls-to-xml

  • Convert an ontology in Excel format to XML.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    input (required) File Input file
    output (required) File Output file

convert-ontology-from-xml-to-xls

  • Convert an ontology XML file to Excel format.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    input (required) File Input file
    output (required) File Output file

convert-sentiment-from-xls-to-xml

  • Convert a sentiment Excel format to XML file.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    input (required) File Input file
    output (required) File Output file

convert-sentiment-from-xml-to-xls

  • Convert a sentiment XML file to Excel format.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    input (required) File Input file
    output (required) File Output file

convert-suggest-from-skos-to-xml

  • Convert a SKOS file to a suggest resource.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    input (required) File Input file
    useAltLabels boolean true Use skos:altLabels properties
    useHiddenLabels boolean true Use skos:hiddenLabels properties
    output (required) File Output file

convert-synonyms-from-skos-to-xml

  • Convert a SKOS file to synonyms resources.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    input (required) File Input file
    useAltLabels boolean true Use skos:altLabels properties
    useHiddenLabels boolean true Use skos:hiddenLabels properties
    useNarrowers boolean true Use skos:narrower properties
    output_lexical (required) File Lexical synonym file (alternative labels)
    output_semantic (required) File Semantic synonym file (narrower/broader)
    output_related (required) File Related synonym file (related)

logging

set-logging-level

  • Set the logging level
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    level (required) class com.exalead.mercury.tools.LoggingConsole$LoggingLevel Logging level to set
    logger String Logger to set
    process (required) Process Process name
    install (required) Install Install name
    host (required) Host Host name

plug-ins

install

  • Install a plug-in
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    name String Force the plug-in name (override what is defined in the plug-in)
    file (required) File Plug-in Zip file

list

  • List the plug-ins
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    details boolean false Print plug-in details

remove

  • Remove a plug-in
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    name (required) String Plug-in name

update

  • Update a plug-in
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    name String Force the plug-in name (override what is defined in the plug-in)
    file (required) File Plug-in Zip file

resources

compile

  • Call the compile MAMI command
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    resource (required) Resource The resource name

declare-ontology-resource

  • Declare a resource for an ontology.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    tokenizationConfig TokenizationConfig tok0 Tokenization config to use
    name (required) String Resource name
    group String search-expansion Resource group to use

declare-synonyms-resource

  • Declare a synonyms dynamic resource.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    tokenizationConfig TokenizationConfig tok0 Tokenization config to use
    name (required) String Resource name
    group String search-expansion Resource group to use

delete-version

  • Delete a version of a resource
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    resource (required) Resource The resource name
    version (required) int 0 The version

delete-versions-before

  • Delete versions of a resource before version
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    resource (required) Resource The resource name
    before (required) int 0 The version

download

  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    resource (required) Resource The resource name
    dest (required) File The local dest
    format String The format if not auto-detected with the file name

get-sample

  • Print a sample resource
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    resource (required) Resource The resource name

internal-add-group

  • Add an internal group
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    group (required) ResourceGroup The group name
    roles (required) String The roles on which the group is published

internal-add-resource-in-group

  • Add an internal resource into an internal group
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    group (required) ResourceGroup The group name
    resource (required) Resource The resource name
    type (required) String The resource type

internal-add-semantic-resource-in-group

  • Add an internal resource into an internal group
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    group (required) ResourceGroup The group name
    resource (required) Resource The resource name
    type (required) String The resource type
    tokenizationConfig (required) TokenizationConfig The tokenization config

internal-del-group

  • Delete an internal group
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    group (required) ResourceGroup The group name

internal-del-resource-from-group

  • Remove an internal resource from an internal group
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    group (required) ResourceGroup The group name
    resource (required) Resource The resource name

list-groups

  • List the configured groups
  • This command is safe to use while CloudView is running.
  • No parameter.

list-resources

  • List the configured resources
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    group (required) ResourceGroup The group name

list-versions

  • List the available version of a resource
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    resource (required) Resource The resource name

prepare-new-version

  • Prepare a new version of a raw resource.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    resource (required) Resource The resource name
    comment String An optional comment

publish

  • Call the publish MAMI command.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    group (required) ResourceGroup The group name

rollback-to-version

  • Rollback to a version of a resource
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    resource (required) Resource The resource name
    version (required) int 0 The version
    comment String An optional comment

upload

  • Copy the local source file to the ResourceManager
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    resource (required) Resource The resource name
    path (required) File The local path
    format String The format if not auto-detected with the file name
    publish boolean false True if we want to publish once the file is uploaded
    maxGenKept int 0 Maximum number of generations kept
    comment String An optional comment

suggest

compile-suggest-from-file

  • Compile a suggest file into a suggest resource
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    file (required) File The suggest XML file
    output (required) File The directory where the suggest resource is stored
    tokenizationConfig (required) TokenizationConfig The tokenization config

create-suggest-file-from-index

  • Create a suggest file based on an index field content and a query
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    output (required) File The destination file
    searchTarget String The search target
    searchLogic SearchLogic The search logic
    searchCommand String The search command pointing to search logic and search target
    field (required) Index6Field The index field
    query String #all The query
    subExpr boolean false
    subString boolean false
    maxEntryLength int 50
    maxSuggestions int 10
    sanitizeEntries boolean false
    splitSentence boolean false
    splitNGrams int 0
    tokenizationConfig String tok0 The tokenization config

dump-suggest-to-xml

  • Run a suggest build and dump results to an XML file.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    name (required) String The Suggest name
    output (required) File Path to the output XML file
    dictionary Dictionary Dictionary name for related-terms based suggest

utils

decrypt-password

  • Decrypt an encrypted password.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    password (required) String The encrypted password

encrypt-password

  • Encrypt a password.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    password (required) String The password in base64

import-certificate

  • Add an existing certificate to the truststore of every product instance. Certificate can either be in DER or PEM format.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    cert-file (required) String Public cert file in DER or PEM format.
    alias String jetty The alias under which the certificate has to be stored.
    password String exalead The keystore password.

cvdebug

analysis

analyze

  • Analyze a file.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    path File File path to send to the analysis
    uri URI Uri of document (default: file path)
    config AnalysisConfig default_model Analysis config name
    pipeline AnalysisPipeline ap0 Analysis pipeline name
    buildGroup BuildGroup bg0 BuildGroup name
    connector Source default Name of source

box

dump

  • Dump URLs and metadata of crawled documents from a crawler's storage (box).
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    crawler (required) String Name of the crawler to dump.
    prefix String Only dump urls beginning with this prefix.

consolidation

compact-cdih

  • Compact the CDIH
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    instance ConsolidationServer Consolidation server instance on which to act
    gen0 (required) int 0 The first generation
    gen1 (required) int 0 The last generation

debug-object-graph

  • Export a debug view of the object graph.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    instance ConsolidationServer Consolidation server instance on which to act
    outputFile (required) String Absolute path to the output file
    workerCount String 4 Number of workers

dump-cdih

  • Dump the content of the CDIH to the standard output.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    instance ConsolidationServer Consolidation server instance on which to act
    source Source Document source
    prefix String Document URI prefix

export-document-store

  • Export the content of the document storage.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    instance ConsolidationServer Consolidation server instance on which to act
    outputFile (required) String Absolute path to the output file

export-object-graph

  • Export the content of the object graph.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    instance ConsolidationServer Consolidation server instance on which to act
    seedNodes String URI of the nodes from which to start the export (for partial export only)
    depth int 0 The depth of the export (for partial export only)
    outputFile (required) String Absolute path to the output file

full-compact-cdih

  • Full compact the CDIH
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    instance ConsolidationServer Consolidation server instance on which to act

full-compact-storage

  • Full compact the storage
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    instance ConsolidationServer Consolidation server instance on which to act

get-document-store-stats

  • Prints document store stats. A document can hold multiple types. You can have results where you wantedstats on one type only but you have several output.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    instance ConsolidationServer Consolidation server instance on which to act (optional)
    type String[] Types for which to compute stats. If not provided, stats are computed on all types. type=myType format. (multivalued and optional)

run-impact-detection

  • It simulates the impact for a given set of URI using the registered rules of your consolidation server, but you can also specify a specific set of rules.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    instance ConsolidationServer Consolidation server instance on which to act (required)
    uri String[] The URIs on which to run the impact detection. uri=myURI format. (multivalued and required)
    graphMatchingExpressionsFile String A graph_matching_expressions file

dict

dump-ngrams

  • Dump a ngrams dictionary.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    lang (required) ISOCode The language of the dictionary to dump
    dictionary (required) Dictionary The dictionary to dump

dump-ngrams-size

  • Dump a ngrams dictionary.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    lang (required) ISOCode The language of the dictionary to dump
    dictionary (required) Dictionary The dictionary to dump

dump-phons

  • Dump a phonemes dictionary
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    lang (required) ISOCode The language of the dictionary to dump
    dictionary (required) Dictionary The dictionary to dump

dump-phons-size

  • Dump a phonemes dictionary.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    lang (required) ISOCode The language of the dictionary to dump
    dictionary (required) Dictionary The dictionary to dump

dump-rt

  • Dump a related-terms dictionary
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    dictionary (required) Dictionary The dictionary to dump

dump-rt-size

  • Dump a related-terms dictionary.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    dictionary (required) Dictionary The dictionary to dump

dump-stream

  • Dump a dict builder stream.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    path (required) File Path to the stream
    lang ISOCode The language to consider, all by default
    type DictionaryResource The resource type to consider, all by default

dump-words

  • Dump a words dictionary.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    lang (required) ISOCode The language of the dictionary to dump
    dictionary (required) Dictionary The dictionary to dump

dump-words-size

  • Dump a words dictionary.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    lang (required) ISOCode The language of the dictionary to dump
    dictionary (required) Dictionary The dictionary to dump

get-resources-size

  • Get the size in bytes of a given dictionary resources.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    dictionary (required) Dictionary The dictionary to get the resources from
    humanize boolean false Humanize the output

index

add-virtual-field

  • Add a virtual field
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    name (required) String The virtual field name
    expression (required) String The virtual field expression

automount

  • Mount all index WORM file systems as regular directories.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    mountPoint (required) String Empty directory where to mount the WORM file systems
    flatten boolean false Mount as a flat file system (when using an aggregated WORM file system, hides the generations and serials)
    detach boolean false Detach the mounted directory from the console (running the `unmount' command is required to unmount the WORM file system)

cleanup

  • Cleanup index directories
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act

compact

  • Compact the index
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    gen0 long 1 The first generation
    gen1 long -1 The last generation

convert-date-to-index-time

  • Convert a date to index time and UNIX timestamp.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    year int 0 year
    month int 1 month (1-12)
    day int 1 day, starting from 1
    hour int 0 hour (0-23)
    min int 0 minute (0-59)
    sec int 0 second (0-59)

convert-from-index-time

  • Convert an index time to UNIX timestamp and date format MM/dd/yyyy hh:mm:ss.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    indextime (required) long 0 The time from the index

convert-timestamp-to-index-time

  • Convert an UNIX timestamp to index time and date.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    uts (required) long 0 UNIX timestamps

debug-list-content

  • Interpret data at the given offset as an inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    offset long 0 The offset at which starts the interpretation
    maxDid int 0 The maximum did of the list

debug-list-header

  • Interpret data at the given offset as an inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    offset long 0 The offset at which starts the interpretation
    maxDid int 0 The maximum did of the list

dump-alphanum-dict

  • Dump an alphanum dictionary.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field Index6Field categories The category field
    gen0 long 1 The first generation
    gen1 long -1 The last generation

dump-alphanum-full-pattern-list

  • Dump an alphanum inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    missingCharMarker (required) char 0 The missing char marker
    wildCardMarker (required) char 0 The wild-card marker
    word (required) String The word of the alphanum of the inverted list
    kind (required) int The kind of the word

dump-alphanum-list

  • Dump an alphanum inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    word (required) String The word of the alphanum of the inverted list
    kind (required) int The kind of the word

dump-alphanum-missing-chars-list

  • Dump an alphanum inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    marker (required) char 0 The missing char marker
    word (required) String The word of the alphanum of the inverted list
    kind (required) int The kind of the word

dump-alphanum-missing-chars-prefix-list

  • Dump an alphanum inverted list
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    marker (required) char 0 The missing char marker
    prefix (required) String The prefix of the alphanum of the inverted list
    kind (required) int The kind of the word

dump-alphanum-prefix-list

  • Dump an alphanum inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    prefix (required) String The prefix of the alphanum of the inverted list
    kind (required) int The kind of the word

dump-attribute-group

  • Dump an attribute group using gen0-gen1
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    attrGroup (required) int 0 The attribute group ID
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    attribute Index6Field Attribute to dump (default = all)

dump-attribute-group-column-infos

  • Dump information on the attributes group columns (ItemStore only).
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    gen0 long 1 The first generation
    gen1 long -1 The last generation

dump-attribute-group-headers

  • Dump the header of attributes group (ItemStore only).
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    gen0 long 1 The first generation
    gen1 long -1 The last generation

dump-attribute-group-sizes

  • Dump sizes in an attribute group using gen0-gen1
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    gen0 long 1 The first generation
    attrGroup int 0 The attribute group ID
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    attribute Index6Field all Attribute the sizes in which to dump

dump-category-list

  • Dump a category inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    path (required) String The path of the category

dump-cdict

  • Dump a category dict using gen0-gen1
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The category or value field
    gen0 long 1 The first generation
    gen1 long -1 The last generation

dump-didlist

  • Dump a DidList
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    gen0 (required) long 0 The first generation
    gen1 (required) long 0 The last generation

dump-field

  • Dump a field.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation

dump-freelist

  • Dump a list of cids that can be recycled during next indexing.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The category or value field
    gen0 long 1 The first generation
    gen1 long -1 The last generation

dump-geofield-wkt

  • Dumps geoV2 indexed data into one single WKT file
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    directory (required) String Directory where the WKT file is created
    number int -1 The number of geometries to dump (-1 means all)

dump-linguistic-streams

  • Dump linguistic streams.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    wormfs (required) String Path to the WormFS
    path (required) String Path inside the WormFS

dump-numerical-list

  • Dump a numerical inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    operator (required) String The numerical operator to apply
    value (required) double The reference value

dump-numerical-range-list

  • Dump a numerical inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    from (required) double The lower bound
    to (required) double The upper bound

dump-octrees

  • Dump octrees.

    In the current directory, it will generate 2 files:

    • octrees.binary that contains concatenated binary octrees
    • octrees.info a csv file with the URL and the offset of the octree in octrees.binary
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act

dump-point-distance-list

  • Dump a point inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    x (required) double The reference position's x coordinate
    y (required) double The reference position's y coordinate
    distance (required) double The reference position's x coordinate

dump-point-kdtree

  • Dumps a point field associated kdtrees to svg files
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    depth int 0 The depth of the inspection
    directory (required) String Directory where the SVG files are created

dump-point-polygon-list

  • Dump a point inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    polygon (required) String The polygon (format: "x1 y1,x2 y2,x3 y3…")

dump-rdict

  • Dump a category dict using gen0-gen1
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The category field
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    maxCid long -1 Max cid to dump

dump-rtree-dot

  • Dumps RTree as Dot graph
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    directory (required) String Directory where the SVG files is created

dump-rtree-mbrs

  • Dumps RTree MBRs (Minimum Bounding Rectangle)
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation

dump-rtree-svg

  • Dumps RTree MBRs (Minimum Bounding Rectangle) as SVG
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    directory (required) String Directory where the SVG files is created
    imageSize int 0 Rescale SVG to the given image size
    withGeoInNodeId int -1 Also dump geometries contained in the given RTree node Id
    depth int -1 How many levels of the rtree to dump
    exactDepthOnly boolean false Keep only nodes at given depth (depth must be set)

dump-vdict

  • Dump a value dict using gen0-gen1
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The value field
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    maxCid long -1 Max cid to dump

estimate-attribute-group-ram-usage

  • Estimate the quantity of RAM required by an attr group
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    attrGroup (required) int 0 The attribute group ID

field-dict-stats

  • Display the statistics of the dictionary of a given field
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation

full-compact

  • Full compact the index
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    ignoreGlobalSupport boolean false Ignore global support (advanced setting, used during migration to 16x)

get-attributes

  • Displays the attributes of a did.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    did (required) int The did

get-did-states

  • Display the states of a did in all slots
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    did (required) int The did

inspect-alphanum-full-pattern-list

  • Inspect an alphanum inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    missingCharMarker (required) char 0 The missing char marker
    wildCardMarker (required) char 0 The wild-card marker
    word (required) String The word of the alphanum of the inverted list
    kind (required) int The kind of the word
    depth int 0 The depth of the inspection

inspect-alphanum-list

  • Inspect an alphanum inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    word (required) String The word of the alphanum of the inverted list
    kind (required) int The kind of the word
    depth int 0 The depth of the inspection

inspect-alphanum-missing-chars-list

  • Inspect an alphanum inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    marker (required) char 0 The missing char marker
    word (required) String The word of the alphanum of the inverted list
    kind (required) int The kind of the word
    depth int 0 The depth of the inspection

inspect-alphanum-missing-chars-prefix-list

  • Inspect an alphanum inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    marker (required) char 0 The missing char marker
    prefix (required) String The prefix of the alphanum of the inverted list
    kind (required) int The kind of the word
    depth int 0 The depth of the inspection

inspect-alphanum-prefix-list

  • Inspect an alphanum inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    prefix (required) String The prefix of the alphanum of the inverted list
    kind (required) int The kind of the word
    depth int 0 The depth of the inspection

inspect-category-list

  • Inspect a category inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    path (required) String The path of the category
    depth int 0 The depth of the inspection

inspect-didlist

  • Inspect a did list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    gen0 (required) long 0 The first generation
    gen1 (required) long 0 The last generation
    depth int 0 The depth of inspection

inspect-didlists

  • Inspect a set of did lists.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    depth int 0 The depth of inspection

inspect-field

  • Inspect a field.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    depth int 0 The depth of the inspection

inspect-numerical-list

  • Inspect a numerical inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    operator (required) String The numerical operator to apply
    value (required) double The reference value
    depth int 0 The depth of the inspection

inspect-numerical-range-list

  • Inspect a numerical inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    from (required) double The lower bound
    to (required) double The upper bound
    depth int 0 The depth of the inspection

inspect-point-distance-list

  • Inspect a point inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    x (required) double The reference position's x coordinate
    y (required) double The reference position's y coordinate
    distance (required) double The reference position's x coordinate
    depth int 0 The depth of the inspection

inspect-point-kdtree

  • Inspect a point field associated kdtrees..
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    depth int 0 The depth of the inspection

inspect-point-polygon-list

  • Inspect a point inverted list.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    field (required) Index6Field The field name
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    polygon (required) String The polygon (format: "x1 y1,x2 y2,x3 y3…")
    depth int 0 The depth of the inspection

inspect-support

  • Inspect the support.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    gen0 long 1 The first generation
    gen1 long -1 The last generation
    depth int 0 The depth of inspection

mount

  • Mount a WORM file system as a regular directory.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    mountPoint (required) String Empty directory where to mount the WORM file system
    flatten boolean false Mount as a flat file system (when using an aggregated WORM file system, hides the generations and serials)
    detach boolean false Detach the mounted directory from the console (running the `unmount' command is required to unmount the WORM file system)

query

  • Perform a query written in ELLQL
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    ellql (required) String The ELLQL query
    virtualFields String[] (multivalued) Specify virtual fields name=expr format
    verbose boolean false Displays all the DID

remove-virtual-field

  • Remove a virtual field
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    slice Slice 0 Slice on which to act
    instance SliceInstance Instance on which to act
    name (required) String The virtual field name

unmount

  • Unmount a WORM file system detached from the console.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    mountPoint (required) String Directory where a WORM file system detached from the console has been mounted

indexing

compact-dih

  • Compact the DIH
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup Build group on which to act
    gen0 (required) int 0 The first generation
    gen1 (required) int 0 The last generation

compact-document-cache

  • Compact the document cache (must be done offline).
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup Build group on which to act
    gen0 (required) int 0 The first generation
    gen1 (required) int 0 The last generation

dump-checkpoint-store

  • Dump the content of the checkpoint store to the standard output.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup Build group on which to act
    source Source Checkpoint source

dump-dih

  • Dump the content of the DIH to the standard output.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup Build group on which to act
    source Source Document source
    prefix String Document URI prefix

dump-document-cache

  • Dump the content of the document cache to the standard output.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup Build group on which to act
    source Source Document source
    prefix String Document URI prefix
    dumpDirectives boolean true Dump document and parts directives
    dumpMetas boolean true Dump document metas
    dumpParts boolean true Dump document parts

export-document-cache

  • Export the content of the document cache on the filesystem.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup Build group on which to act
    source Source Document source
    prefix String Document URI prefix
    exportDirectives boolean true Export document and parts directives
    exportMetas boolean true Export document metas
    exportParts boolean true Export document parts
    outputDir (required) String Output directory

full-compact-dih

  • Full compact the DIH.
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup Build group on which to act

full-compact-document-cache

  • Full compact the document cache
  • This command is unsafe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup Build group on which to act

linguistic

dump-ontology

  • Dump an ontology.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    path (required) File Path to compiled ontology

process

create-launcher

  • Create a script to start a process with various arguments (Linux ONLY)
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    process (required) Process Name of the process

run

  • Start a process
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    process (required) Process Name of the process to start
    debugmalloc boolean false Enable debugmalloc
    debugger boolean false Run with debugger
    attachdebugger boolean false Attach a debugger in case of crash
    env String[] (multivalued) Additional environment

show-command

  • Show the command used to start a process.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    process (required) Process Name of the process to start

regex

match

  • Parse, compile the specified regular expression, then eventually match an input string and substitute the matches in a sed like output format.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    regex (required) String expression to be compiled. Supports most Perl 5 syntax
    input String string to be matched by the regex
    replacement String string used to replace the match in the input string. Supports sed-like output format
    caseInsensitive boolean false match string with no distinction between capital letters and minuscules
    normalized boolean false match string regardless the case and accent differences
    leftAnchor boolean false match only at the beginning of the input
    rightAnchor boolean false match only at the end of the input

semantic

annotate

  • Process a string and dump the generated annotated tokens.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    value String Text to process, standard input if missing
    language ISOCode Iso code of the language
    context String Context of the chunk
    pipeline AnalysisPipeline ap0 Analysis pipeline to use

annotate-file

  • Process an entire text file and dump the generated annotated tokens.
  • This command is safe to use while CloudView is running.
  • Parameters:
    Name Type Default value Description
    buildGroup BuildGroup bg0 Build group on which to act
    path (required) File Path to file to process
    encoding String UTF-8 File encoding
    language ISOCode Iso code of the language
    context String Context of the chunk
    pipeline AnalysisPipeline ap0 Analysis pipeline to use

dump-pipe

  • Dump the current MOT pipe.
  • This command is safe to use while CloudView is running.
  • No parameter.