Constructor NoSQLClient
NoSQLClient(NoSQLConfig)
Initializes new instance of NoSQLClient using
provided configuration object. You may omit
Declaration
public NoSQLClient(NoSQLConfig config = null)
Parameters
Type | Name | Description |
---|---|---|
NoSQLConfig | config | (Optional) Client configuration object. |
Remarks
You may omit config
parameter or pass
null
if using the cloud service with the default OCI
configuration file that contains credentials and region
identifier. In this case, a default NoSQLConfig
instance will be created. In all other cases, a valid
NoSQLConfig object must be provided.
See NoSQLConfig() for more details.
Note that NoSQLConfig will be copied when creating NoSQLClient instance, so that the modifications to NoSQLConfig will have no effect on existing NoSQLClient instances which are immutable.
Exceptions
Type | Condition |
---|---|
ArgumentException | If config
is invalid or inconsistent, or config is not
provided and default NoSQLConfig instance cannot be
used as described above. |
See Also
NoSQLClient(String)
Initializes new instance of NoSQLClient using
provided path to JSON configuration file.
Declaration
public NoSQLClient(string configFile)
Parameters
Type | Name | Description |
---|---|---|
String | configFile | Path to JSON configuration file as either absolute path or relative to the current directory of the application. |
Remarks
This is equivalent to
using NoSQLClient(NoSQLConfig) constructor and
passing the result of
FromJsonFile(String) as parameter.
Exceptions
Type | Condition |
---|---|
ArgumentException | If failed to parse provided
configFile (file is not found, cannot be read,
does not contain valid JSON or valid data to instantiate
NoSQLConfig) or if resulting
NoSQLConfig is invalid or inconsistent. |