Methods
bigDec(s) → {BigDec}
Convert the argument to a shared.BigDec.
Parameters:
Name | Type | Description |
---|---|---|
s |
The input. |
Returns:
The big decimal.
- Type
- BigDec
bigInt(s) → {shared.BigInt}
Convert the argument to a shared.BigInt.
Parameters:
Name | Type | Description |
---|---|---|
s |
The input. |
Returns:
The big int.
- Type
- shared.BigInt
(async) connect(args) → {Promise.<*>}
Connect to a Datomic database. Takes an object of arguments,
required arguments are:
- serverType: either 'cloud' (alias 'ion') or 'peer-server' (alias 'client').
- dbName: the database name to connect to.
- system: Your cloud system name. Required.
- region: Your AWS region. Required.
- endpoint: Your cloud entry URL. Required.
- proxyPort: The socks proxy port to use (on localhost), when using the bastion server. Optional.
- endpoint: The peer-server endpoint. Required.
- accessKey: Your access key. Required.
- secret: Your secret. Required.
Parameters:
Name | Type | Description |
---|---|---|
args |
The arguments. |
Returns:
The promise that will yield the connection, or an error.
- Type
- Promise.<*>
count(symbol)
Return a count expression, for use in
Parameters:
Name | Type | Description |
---|---|---|
symbol |
The symbol name being queried. |
Returns:
The constructed count expression.
(async) createDatabase(args) → {Promise.<boolean>
Create a new database (only supported with cloud).
The arguments are the same as those passed to #connect.
Parameters:
Name | Type | Description |
---|---|---|
args |
Returns:
The promise that will yield true when the
database is created, or yields an error.
- Type
- Promise.<boolean>
(async) deleteDatabase(args) → {Promise.<boolean>}
Delete a database (only supported with cloud).
The arguments are the same as those passed to @connect.
Parameters:
Name | Type | Description |
---|---|---|
args |
Returns:
The promise that will yield true when the
database is deleted, or yields an error.
- Type
- Promise.<boolean>
keyword(s) → {*}
Convert the argument to a keyword.
Parameters:
Name | Type | Description |
---|---|---|
s |
The string or keyword. |
Returns:
The keyword.
- Type
- *
(async) listDatabases(args) → {Promise.<*>}
List databases in your system.
The arguments are the same as #connect, except omit the dbName parameter.
Parameters:
Name | Type | Description |
---|---|---|
args |
The arguments. |
Returns:
The promise that will yield an array of database names (strings),
or an error.
- Type
- Promise.<*>
pull(eid, selector)
Build a pull expression for use in a datomic query. The result
is typically passed to #find.
Parameters:
Name | Type | Description |
---|---|---|
eid |
A string describing the symbol name to use in the pull. | |
selector |
A selector that conforms to the datomic selector syntax, that is, nested arrays and objects, with the refinement that keywords may be represented just as strings. |
symbol(s) → {*}
Convert the argument to a symbol.
Parameters:
Name | Type | Description |
---|---|---|
s |
A string, or a symbol. |
Returns:
The symbol.
- Type
- *
uuid(s) → {UUID}
Convert the argument string to a shared.UUID.
Parameters:
Name | Type | Description |
---|---|---|
s |
The string. |
Returns:
The UUID.
- Type
- UUID