datalevin.client — datalevin 0.9.14

Datalevin client to Datalevin server, blocking API, with a connection pool

assign-role clj

(assign-role client role-key username)

Assign a role to a user.

close-database clj

(close-database client db-name)

Force close a database. Connected clients that are using it will be disconnected.

See disconnect-client

create-database clj

(create-database client db-name db-type)

Create a database. db-type can be :datalog or :key-value. db-name will be converted to Kebab case (i.e. all lower case and words connected with dashes).

create-role clj

(create-role client role-key)

Create a role. role-key is a keyword.

create-user clj

(create-user client username password)

Create a user that can login. username will be converted to Kebab case (i.e. all lower case and words connected with dashes).

disconnect-client clj

(disconnect-client client client-id)

Force disconnect a client from the server.

drop-database clj

(drop-database client db-name)

Delete a database. May not be successful if currently in use.

See close-database

drop-role clj

(drop-role client role-key)

Delete a role. role-key is a keyword.

drop-user clj

(drop-user client username)

Delete a user.

grant-permission clj

(grant-permission client role-key perm-act perm-obj perm-tgt)

Grant a permission to a role.

perm-act indicates the permitted action. It can be one of :datalevin.server/view, :datalevin.server/alter, :datalevin.server/create, or :datalevin.server/control, with each subsumes the former.

perm-obj indicates the object type of the securable. It can be one of :datalevin.server/database, :datalevin.server/user, :datalevin.server/role, or :datalevin.server/server, where the last one subsumes all the others.

perm-tgt indicate the concrete securable target. It can be a database name, a username, or a role key, depending on perm-obj. If it is nil, the permission applies to all securables in that object type.

list-databases clj

(list-databases client)

List all databases.

list-databases-in-use clj

(list-databases-in-use client)

List databases that are in use.

list-role-permissions clj

(list-role-permissions client role-key)

List the permissions granted to a role.

See grant-permission.

list-roles clj

(list-roles client)

List all roles.

list-user-permissions clj

(list-user-permissions client username)

List the permissions granted to a user through the roles assigned.

list-user-roles clj

(list-user-roles client username)

List the roles assigned to a user.

list-users clj

(list-users client)

List all users.

new-client clj

(new-client uri-str)

(new-client uri-str
            {:keys [pool-size time-out]
             :or {pool-size c/default-connection-pool-size
                  time-out c/default-connection-timeout}})

Create a new client that maintains pooled connections to a remote Datalevin database server. This operation takes at least 0.5 seconds in order to perform a secure password hashing that defeats cracking.

Fields in the uri-str should be properly URL encoded, e.g. user and password need to be URL encoded if they contain special characters.

The following can be set in the optional map:

• :pool-size determines number of connections maintained in the connection pool, default is 3.
• :time-out specifies the time (milliseconds) before an exception is thrown when obtaining an open network connection, default is 60000.

open-database clj

(open-database client db-name db-type)

(open-database client db-name db-type opts)

(open-database client db-name db-type schema opts)

Open a database on server. db-type can be "datalog", "kv", or "engine"

query-system clj

(query-system client query & arguments)

Issue arbitrary Datalog query to the system database on the server. Note that unlike q function, the arguments here should NOT include db, as the server will supply it.

reset-password clj

(reset-password client username password)

Reset a user's password.

revoke-permission clj

(revoke-permission client role-key perm-act perm-obj perm-tgt)

Revoke a permission from a role.

See grant-permission.

show-clients clj

(show-clients client)

Show information about the currently connected clients on the server.

withdraw-role clj

(withdraw-role client role-key username)

Withdraw a role from a user.