Liking cljdoc? Tell your friends :D

prequels.core

Component wrapping a SQL connection, for usage in org.clojure/java.jdbc.

Argument reference for SQLConnection:

  • :secret-store A value that satisfies lore.api.async/IAsyncSecretStore. Typically this is another component (e.g. lore.component/SecretStore). Only used if the password is encrypted in arg-map.
  • :connection-type A keyword, either :static or :rds.
  • :arg-map A map of arguments.

For :static connection types, arg-map should be a java.jdbc DB spec map, but may also contain a key :encrypted-password instead of :password. If no :password is given but :encrypted-password is, it should be a base-64 encoded string, byte array, or input stream containing the encrypted password. On start, the encrypted password is decrypted via the secret-store.

For :rds connection types, the :encrypted-password key is handled as above, and the other arguments are:

  • :cluster-id The name of the RDS cluster to look up (required).
  • :db-name The DB name to connect to.
  • :user The database user to authenticate with.
  • :read-only? A boolean, if true, fetch the read-only endpoint of the cluster, if available. Otherwise fetches the main endpoint. Default true.
  • aws Argument map to pass to cognitect.aws.client.api/client, to override any
Component wrapping a SQL connection, for usage in org.clojure/java.jdbc.

Argument reference for SQLConnection:

* `:secret-store` A value that satisfies `lore.api.async/IAsyncSecretStore`. Typically
  this is another component (e.g. `lore.component/SecretStore`). Only used if the password
  is encrypted in `arg-map`.
* `:connection-type` A keyword, either `:static` or `:rds`.
* `:arg-map` A map of arguments.

For `:static` connection types, `arg-map` should be a java.jdbc DB spec map, but
*may* also contain a key `:encrypted-password` instead of `:password`. If no `:password`
is given but `:encrypted-password` is, it should be a base-64 encoded string, byte
array, or input stream containing the encrypted password. On start, the encrypted
password is decrypted via the secret-store.

For `:rds` connection types, the `:encrypted-password` key is handled as above, and
the other arguments are:

* `:cluster-id` The name of the RDS cluster to look up (required).
* `:db-name` The DB name to connect to.
* `:user` The database user to authenticate with.
* `:read-only?` A boolean, if true, fetch the read-only endpoint of the cluster,
  if available. Otherwise fetches the main endpoint. Default true.
* `aws` Argument map to pass to `cognitect.aws.client.api/client`, to override
  any
raw docstring

No vars found in this namespace.

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcutsReport a problemcljdoc on GitHub
× close