v0.9.5-SNAPSHOT

GeoWave Command Line Controls geowave-icon-logo-cropped

Commands

Helpful Commands & Flags

GeoWave supports a few extra commands that can be used for informational purposes to debug or explore command usage.

Debug Flag (--debug)

Use the debug flag to increase the debug logging output by GeoWave on the console to DEBUG. By default, it is set to WARN. This flag must come right after 'geowave' and before any subcommand:

geowave --debug <command> <subcommand> <options...>

Version Flag (--version)

The version flag will output the build arguments that were used to build GeoWave, as well as the version of the GeoWave tools jar you’re using:

geowave --version

Help Command

The help command will show arguments and their defaults. It can be prepended to any GeoWave command. If you use it while also specifying a sub-command and its arguments, that command’s help information will be displayed:

geowave help <command> <subcommand>

Explain Command

The explain command will show a simplified tabular view of the arguments and their current values. Use this to determine what values are being passed to GeoWave. It also shows hidden parameters and their values, if there are any. An example would be additional Accumulo options:

geowave explain config addstore -t accumulo

Config Commands

Commands that affect local configuration only (Required options are designated with an *)

geowave config addindex

NAME

geowave config addindex - creates an index configuration for use in GeoWave

SYNOPSIS

geowave config addindex [options] <name>

DESCRIPTION

The geowave config addindex operator will create a local index configuration that can be reused but is not associated with a store until data is ingested.

OPTIONS

  • -d, --default

    • Make this the default index for creating stores

  • -np, --numPartitions <arg>

    • The number of partitions

    • Default: 1

  • -ps, --partitionStrategy <arg>

    • The partition strategy to use

    • Default: NONE

    • Possible Values: NONE, HASH, ROUND_ROBIN

  • *-t, --type <arg>

    • The type of index, such as spatial or spatial_temporal

    • Required!

    • When -t, --type is spatial, the following options are available

      • --allTiers

        • The index will represent all tiers. Typically for vector data we only need a subset of the tiers to minimize query decomposition, but for raster data typically all tiers is better.

        • Default: false

      • -d, --default

        • Make this the default index creating stores

      • -np, --numPartitions

        • The number of partitions.

          • Default: 1

      • -ps, --partitionStrategy

        • The partition strategy to use.

          • Default: NONE

          • Possible Values: [NONE, HASH, ROUND_ROBIN]

      • --pointOnly

        • The index will only be good at handling pointsand will not be optimized for handling lines/polys. The default behavior is to handle any geometry. Default: false

    • When -t, --type is spatial_temporal, the following options are available

      • --bias

        • The bias of the spatial-temporal index. There can be more precision given to time or space if necessary.

        • Default: BALANCED

        • Possible Values: [TEMPORAL, BALANCED, SPATIAL]

      • -d, --default

        • Make this the default index creating stores

      • -np, --numPartitions

        • The number of partitions.

        • Default: 1

      • -ps, --partitionStrategy

        • The partition strategy to use.

        • Default: NONE

        • Possible Values: [NONE, HASH, ROUND_ROBIN]

      • --period

        • The periodicity of the temporal dimension. Because time is continuous, it is binned at this interval.

        • Default: YEAR

        • Possible Values: [DAY, MONTH, YEAR]

      • --pointTimestampOnly

        • The index will only be good at handling points and timestamps and will not be optimized for handling lines/polys or time ranges. The default behavior is to handle any geometry and time ranges well.

        • Default: false

geowave config addindexgrp

NAME

geowave config addindexgrp - Group multiple index configurations together given a name

SYNOPSIS

geowave config addindexgrp [options] <name> <comma separated list of indexes>

DESCRIPTION

The geowave config addindexgrp operator will group multiple index configurations together given a name. This acts as a convenience for re-using multiple indices together on ingest.

OPTIONS

There are currently no options for this command

geowave config addstore

NAME

geowave config addstore - creates a new store in GeoWave

SYNOPSIS

geowave config addstore [options] <name>

DESCRIPTION

The geowave config addstore operator will create a new store in GeoWave.

OPTIONS

  • -d, --default

    • Make this the default store in all operations

  • *-t, --type <arg>

    • The type of store, such as accumulo, memory, etc.

    • Required!

    • When -t accummulo option is used, additional options are:

      • --gwNamespace

        • The geowave namespace

          • Default is no namespace

      • *-i, --instance

        • The Accumulo instance ID

        • Required!

      • *-p, --password

        • The password for the user

        • Required!

      • *-u, --user

        • A valid Accumulo user ID

        • Required!

      • *-z, --zookeeper

        • A comma-separated list of zookeeper servers that an Accumulo instance is using

        • Required!

    • When -t, --type hbase option is used, additional options are:

      • -d, --default

        • Make this the default index creating stores

      • -np, --numPartitions

        • The number of partitions.

        • Default: 1

      • -ps, --partitionStrategy

        • The partition strategy to use.

        • Default: NONE

        • Possible Values: [NONE, HASH, ROUND_ROBIN]

geowave config cpindex

NAME

geowave config cpindex - copies and modifies an existing index configuration

SYNOPSIS

geowave config cpindex [options] <name> <new name>

DESCRIPTION

The geowave config cpindex operator will copy and modify an existing index configuration. It is possible to override values as you copy, such as cpindex old new --gwNamespace new_namespace.

OPTIONS

  • -d, --default

    • Make this the default index creating stores

  • -np, numPartitions

    • The number of partitions.

    • Default: 1

  • -ps, --partitionStrategy

    • The partition strategy to use.

    • Default: NONE

    • Possible Values: [NONE, HASH, ROUND ROBIN]

geowave config cpstore

NAME

geowave config cpstore - copies and modifies an existing GeoWave store

SYNOPSIS

geowave config cpstore [options] <name> <new name>

DESCRIPTION

The geowave cpstore operator will copy and modify an existing GeoWave store. It is possible to override values as you copy, such as cpstore old new --gwNamespace new_namespace.

OPTIONS

  • -d, --default

    • Makes this the default store in all operations

geowave config list

NAME

geowave config list - will list all properties in local config

SYNOPSIS

geowave config list [options]

DESCRIPTION

The geowave config list operator will list all properties in local config. -f or --filter will allow you to give a regex to filter the list by (useful regexes may be 'store' or 'index' to isolate properties for one or the other or a particular store/index name to further isolate the list).

OPTIONS

  • -f or --filter <arg>

    • Filter list by a regex

geowave config rmindex

NAME

geowave config rmindex - removes an index configuration from GeoWave configuration

SYNOPSIS

geowave config rmindex [options] <name>

DESCRIPTION

The geowave config rmindex operator will remove an index configuration from GeoWave configuration

OPTIONS

There are currently no options for this command

geowave config rmindexgrp

NAME

geowave config rmindexgrp - removes an index group from GeoWave configuration

SYNOPSIS

geowave config rmindexgrp [options] <name>

DESCRIPTION

The geowave config rmindexgrp operator will remove an index group from GeoWave configuration

OPTIONS

There are currently no options for this command

geowave config rmstore

NAME

geowave config rmstore - removes an existing store from GeoWave configuration

SYNOPSIS

geowave config rmstore [options] <name>

DESCRIPTION

The geowave config rmstore operator will remove an existing store from GeoWave configuration GeoWave store

OPTIONS

There are currently no options for this command

geowave config set

NAME

geowave config set - will set a valid property name within the cache

SYNOPSIS

geowave config set [options]

DESCRIPTION

The geowave config set operator will set a valid property name within the cache. This can be useful if you want to update a particular property of a index or store.

OPTIONS

There are currently no options for this command

---

Ingest Commands

Commands that ingest data directly into GeoWave or stage data to be ingested into GeoWave (Required options are designated with an *)

geowave ingest listformat

NAME

geowave remote listformat - List supported ingest formats

SYNOPSIS

geowave remote listformat [options]

DESCRIPTION

The geowave remote listformat lists supported ingest formats

OPTIONS

There are currently no options for this command

geowave ingest localToGW

NAME

geowave ingest localToGW - Ingest supported files in local file system directly, without using HDFS

SYNOPSIS

geowave ingest localToGW [options] <file or directory> <storename> <comma delimited index/group list>

DESCRIPTION

The geowave ingest localToGW operator will run the ingest code (parse to features, load features to geowave) against local file system content.

OPTIONS

  • -x, --extension

    • individual or comma-delimited set of file extensions to accept

  • -f, --formats

    • Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used

  • -t, --threads

    • number of threads to use for ingest

    • Default is 1

  • -v, --visibility

    • The visibility of the data ingested

    • Default is 'public'

geowave ingest localToMrGW

NAME

geowave ingest localToMrGW - Copy supported files from local file system to HDFS and ingest from HDFS

SYNOPSIS

geowave ingest localToMrGW [options] <file or directory> <hdfs host:port> <path to base directory to write to> <store name> <comma delimited index/group list>

DESCRIPTION

The geowave ingest localToMrGW operator will Copy supported files from local file system to HDFS and ingest from HDFS

OPTIONS

  • -x, --extension

    • individual or comma-delimited set of file extensions to accept

  • -f, --formats

    • Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used

  • --jobtracker

    • Hadoop job tracker hostname and port in the format hostname:port

  • --resourceman

    • Yarn resource manager hostname and port in the format hostname:port

  • -v, --visibility

    • The visibility of the data ingested

    • Default is 'public'

geowave ingest localToHdfs

NAME

geowave ingest localToHdfs - Stage supported files in local file system to HDFS

SYNOPSIS

geowave ingest localToHdfs [options] <file or directory> <hdfs host:port> <path to base directory to write to>

DESCRIPTION

The geowave ingest localToHdfs operator will stage supported files in the local file system to HDFS

OPTIONS

  • -x, --extension

    • individual or comma-delimited set of file extensions to accept

  • -f, --formats

    • Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used

geowave ingest localToKafka

NAME

geowave ingest localToKafka - Stage supported files in local file system to a Kafka topic

SYNOPSIS

geowave ingest localToKafka [options] <file or directory>

DESCRIPTION

The geowave ingest localToKafka operator will stage supported files in the local file system to a Kafka topic

OPTIONS

  • -x, --extension

    • individual or comma-delimited set of file extensions to accept

  • -f, --formats

    • Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used

  • *--kafkaprops

    • Properties file containing Kafka properties

  • --metadataBrokerList

    • This is for bootstrapping and the producer will only use it for getting metadata (topics, partitions and replicas). The socket connections for sending the actual data will be established based on the broker information returned in the metadata. The format is host1:port1,host2:port2, and the list can be a subset of brokers or a VIP pointing to a subset of brokers.

  • --producerType

    • This parameter specifies whether the messages are sent asynchronously in a background thread. Valid values are (1) async for asynchronous send and (2) sync for synchronous send. By setting the producer to async we allow batching together of requests (which is great for throughput) but open the possibility of a failure of the client machine dropping unsent data.

  • --requestRequiredAcks

    • This value controls when a produce request is considered completed. Specifically, how many other brokers must have committed the data to their log and acknowledged this to the leader?

  • --retryBackoffMs

    • The amount of time to wait before attempting to retry a failed produce request to a given topic partition. This avoids repeated sending-and-failing in a tight loop.

  • --serializerClass

    • The serializer class for messages. The default encoder takes a byte[] and returns the same byte[].

geowave ingest kafkaToGW

NAME

geowave ingest kafkaToGW - Subscribe to a Kafka topic and ingest into GeoWave

SYNOPSIS

geowave ingest kafkaToGW [options] <store name> <comma delimited index/group list>

DESCRIPTION

The geowave ingest kafkaToGW operator will ingest supported files that already exist in HDFS

OPTIONS

  • --autoOffsetReset

    • What to do when there is no initial offset in ZooKeeper or if an offset is out of range:

      • smallest : automatically reset the offset to the smallest offset

      • largest : automatically reset the offset to the largest offset

      • anything else: throw exception to the consumer

  • --batchSize

    • The data will automatically flush after this number of entries

    • Default is 10000

  • --consumerTimeoutMs

    • By default, this value is -1 and a consumer blocks indefinitely if no new message is available for consumption. By setting the value to a positive integer, a timeout exception is thrown to the consumer if no message is available for consumption after the specified timeout value.

  • -x, --extension

    • individual or comma-delimited set of file extensions to accept

  • --fetchMessageMaxBytes

    • The number of bytes of messages to attempt to fetch for each topic-partition in each fetch request. These bytes will be read into memory for each partition, so this helps control the memory used by the consumer. The fetch request size must be at least as large as the maximum message size the server allows or else it is possible for the producer to send messages larger than the consumer can fetch.

  • -f, --formats

    • Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used

  • --groupId

    • A string that uniquely identifies the group of consumer processes to which this consumer belongs. By setting the same group id multiple processes indicate that they are all part of the same consumer group.

  • *--kafkaprops

    • Properties file containing Kafka properties

  • --reconnectOnTimeout

    • This flag will flush when the consumer timeout occurs (based on kafka property 'consumer.timeout.ms') and immediately reconnect Default: false

  • -v, --visibility

    • The visibility of the data ingested

    • Default is 'public'

  • --zookeeperConnect

    • Specifies the ZooKeeper connection string in the form hostname:port where host and port are the host and port of a ZooKeeper server. To allow connecting through other ZooKeeper nodes when that ZooKeeper machine is down you can also specify multiple hosts in the form hostname1:port1,hostname2:port2,hostname3:port3.

geowave ingest mrToGW

NAME

geowave ingest mrToGW - Ingest supported files that already exist in HDFS

SYNOPSIS

geowave ingest mrToGW [options] <file or directory> <hdfs host:port> <path to base directory to write to> <store name> <comma delimited index/group list>

DESCRIPTION

The geowave ingest mrToGW operator will ingest supported files that already exist in HDFS

OPTIONS

  • -x, --extension

    • individual or comma-delimited set of file extensions to accept

  • -f, --formats

    • Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used

  • --jobtracker

    • Hadoop job tracker hostname and port in the format hostname:port

  • --resourceman

    • Yarn resource manager hostname and port in the format hostname:port

  • -v, --visibility

    • The visibility of the data ingested

    • Default is 'public'

---

Remote Commands

Operations to manage a remote store

geowave remote calcstat

NAME

geowave remote calcstat - Calculate a specific statistic in the remote store, given adapter ID and statistic ID

SYNOPSIS

geowave remote calcstat [options] <store name> <adapterId> <statId>

DESCRIPTION

The geowave remote calcstat operator will calculate a specific statistic in the remote store, given adapter ID and statistic ID.

OPTIONS

  • --auth

    • The authorizations used for the statistics calculation as a subset of the accumulo user authorization; by default all authorizations are used.

geowave remote clear

NAME

geowave remote clear - Clear ALL data from a GeoWave store and delete tables

SYNOPSIS

geowave remote clear [options] <store name>

DESCRIPTION

The geowave remote clear operator will clear ALL data from a GeoWave store and delete tables

OPTIONS

There are currently no options for this command

geowave remote listadapter

NAME

geowave ingest listadapter - display all adapters in this remote store

SYNOPSIS

geowave ingest listadapter [options] <store name>

DESCRIPTION

The geowave ingest listadapter operator will display all adapters in this remote store.

OPTIONS

There are currently no options for this command

geowave remote listindex

NAME

geowave remote listindex - Display all indices in this remote store

SYNOPSIS

geowave remote listindex [options] <store name>

DESCRIPTION

The geowave remote listindex operator will display all indices in a specific remote store

OPTIONS

There are currently no options for this command

geowave remote liststats

NAME

geowave remote liststats - Print statistics of an existing GeoWave dataset to standard output

SYNOPSIS

geowave remote liststats [options] <store name> [<adapter name>]

DESCRIPTION

The geowave remote liststats operator will print statistics of an existing GeoWave dataset to standard output

OPTIONS

  • --auth

    • The authorizations used for the statistics calculation as a subset of the accumulo user authorization; by default all authorizations are used.

geowave remote recalcstats

NAME

geowave remote recalcstats - Calculate the statistics of an existing GeoWave dataset

SYNOPSIS

geowave remote recalcstats [options] <store name> <adapterId> <statId>

DESCRIPTION

The geowave remote recalcstats operator will calculate the statistics of an existing GeoWave dataset

OPTIONS

  • --auth

    • The authorizations used for the statistics calculation as a subset of the accumulo user authorization; by default all authorizations are used.

geowave remote rmstat

NAME

geowave remote rmstat - Remove a statistic from the remote store

SYNOPSIS

geowave remote rmstat [options] <store name> <adapterId> <statId>

DESCRIPTION

The geowave remote rmstat operator will Remove a statistic from the remote store. You will be prompted with "Are you sure?"

OPTIONS

  • --auth

    • The authorizations used for the statistics calculation as a subset of the accumulo user authorization; by default all authorizations are used.

---