com.sequoiadb.base

Class ClientOptions

java.lang.Object

com.sequoiadb.base.ClientOptions

public class ClientOptions
extends Object

Global configuration of SequoiaDB driver. When using the SequoiaDB driver, you can specify its global configuration and initialize it with Sequoiadb.initClient(ClientOptions)

Usage example:

 ClientOptions options = new ClientOptions();
 options.setEnableCache( true );
 options.setCacheInterval( 300 * 1000 );  // 300s
 options.setExactlyDate( false );

 Sequoiadb.initClient( options );
 

Constructor Summary

Constructors

Constructor and Description
ClientOptions() The construction method of ClientOptions.

Method Summary

Modifier and Type	Method and Description
long	getCacheInterval()
boolean	getEnableCache()
Boolean	getExactlyDate()
void	setCacheInterval(long interval) Set the interval for caching the name of collection space and collection in client in milliseconds.
void	setEnableCache(boolean enable) Set caching the name of collection space and collection in client or not.
void	setExactlyDate(boolean exactlyDate) Whether to use exactly date, default is false.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientOptions

public ClientOptions()

The construction method of ClientOptions.

Method Detail

getCacheInterval

public long getCacheInterval()

Returns:

The value of caching interval.

getEnableCache

public boolean getEnableCache()

Returns:

True if cache is enabled and false if not.

getExactlyDate

public Boolean getExactlyDate()

Returns:

A boolean value to indicate whether use exactly date or not

setCacheInterval

public void setCacheInterval(long interval)

Set the interval for caching the name of collection space and collection in client in milliseconds. This value should not be less than 0, or it will be set to the default value, default value is 300*1000ms.

Parameters:

interval - The interval in milliseconds.

setEnableCache

public void setEnableCache(boolean enable)

Set caching the name of collection space and collection in client or not.

Parameters:

enable - True or false.

setExactlyDate

public void setExactlyDate(boolean exactlyDate)

Whether to use exactly date, default is false. False indicates that the hours, minutes, seconds and milliseconds of java.util.Date are valid. True indicates that they are meaningless and the SequoiaDB driver will discard the hours, minutes, seconds and milliseconds of java.util.Date.

 Example:
 A instance of java.util.Date is "2022-01-01 01:01:01", insert it to SequoiaDB with the SequoiaDB driver.
 1. exactlyDate is false: the inserted data is "2022-01-01 01:01:01"
 2. exactlyDate is true: the inserted data is "2022-01-01 00:00:00"
 

Parameters:

exactlyDate - True or false.