18.2. Using the Redis Data Store Programmatically¶

18.2.1. Creating a Data Store¶

An instance of a Redis data store can be obtained through the normal GeoTools discovery methods, assuming that the GeoMesa code is on the classpath.

Map<String, Serializable> parameters = new HashMap<>();
parameters.put("redis.url", "redis://localhost:6379");
parameters.put("redis.catalog", "geomesa");
org.geotools.api.data.DataStore dataStore =
    org.geotools.api.data.DataStoreFinder.getDataStore(parameters);

18.2.2. Redis Data Store Parameters¶

The data store takes several parameters (required parameters are marked with *):

Parameter	Type	Description
`redis.url *`	String	Redis connection URL. The URL can be used to specify the Redis database and credentials, if required - for example, ‘redis://user:pass@host:port/db’
`redis.catalog *`	String	The name of the GeoMesa catalog table. In Redis, this is the base key used for inserts
`redis.connection.pool.size`	Integer	Max number of simultaneous connections to use
`redis.connection.pool.validate`	Boolean	Test connections when borrowed from the pool. Connections may be closed due to inactivity, which would cause a transient error if validation is disabled
`redis.connection.timeout`	String	Timeout for socket connections to Redis. The timeout is specified as a duration, e.g. `10 seconds`. The default value is `2 seconds`
`redis.pipeline.enabled`	Boolean	Enable pipelining of query requests. This reduces network latency, but restricts queries to a single execution thread
`geomesa.query.threads`	Integer	The number of threads to use per query (if not pipelining)
`geomesa.query.timeout`	String	The max time a query will be allowed to run before being killed. The timeout is specified as a duration, e.g. `1 minute` or `60 seconds`
`geomesa.stats.enable`	Boolean	Toggle collection of statistics for newly created feature types
`geomesa.query.audit`	Boolean	Audit queries being run. Queries will be written to a log file
`geomesa.query.loose-bounding-box`	Boolean	Use loose bounding boxes - queries will be faster but may return extraneous results
`geomesa.security.auths`	String	Comma-delimited superset of authorizations that will be used for queries
`geomesa.security.force-empty-auths`	Boolean	Forces authorizations to be empty
`geomesa.partition.scan.parallel`	Boolean	For partitioned schemas, execute scans in parallel instead of sequentially

More information on using GeoTools can be found in the GeoTools user guide.