ReQL command: connection

Command syntax

r.connection() → Connection.Builder

Description

Create a new connection to the database server. connection returns a builder object with the following methods:

• hostname(String): the host to connect to (default localhost).
• port(Integer): the port to connect on (default 28015).
• db(String): the default database (default test).
• user(String, String): the user account and password to connect as (default "admin", "").
• authKey(String): the auth key to connect with (default null).
• sslContext(SSLContext): an instance of an SSLContext class to use for SSL connections.
• certFile(InputStream): an InputStream, which will be read and converted into an SSLContext.
• timeout(Long): timeout period in seconds for the connection to be opened (default null).
• socketFactory(ConnectionSocket.Factory): A factory to override the default connection socket (default null, which uses the default factory).
• pumpFactory(ResponsePump.Factory): A factory to override the default response pump (default null, which uses the default factory).
• unwrapLists(boolean): If enabled, will unwrap atom responses which are lists for convenience (default false).
• defaultFetchMode(Result.FetchMode): Overrides the connection’s fetch mode regarding partial sequences (default Result.FetchMode.LAZY).

Either certFile or sslContext must be supplied to make an SSL connection to the RethinkDB server. Only one should be used.

If the connection cannot be established, a ReqlDriverError will be thrown.

Using SSL with RethinkDB requires proxy software on the server, such as Nginx, HAProxy or an SSL tunnel. RethinkDB will encrypt traffic and verify the CA certification to prevent man-in-the-middle attacks. Consult your proxy’s documentation for more details.

Alternatively, you may use RethinkDB’s built-in TLS support.

Example: Open a connection using the default host and port, specifying the default database.

Connection conn = r.connection().connect();

Example: Open a new connection, specifying parameters.

Connection conn = r.connection()
    .hostname("localhost")
    .port(28015)
    .dbname("marvel")
    .connect();

Example: Open a new connection, specifying a user/password combination for authentication.

Connection conn = r.connection()
    .hostname("localhost")
    .port(28015)
    .dbname("marvel")
    .user("herofinder", "metropolis")
    .connect();

Example: Open a new connection to the database using an SSL proxy.

Connection conn = r.connection()
    .hostname("localhost")
    .port(28015)
    .dbname("marvel")
    .authKey("hunter2")
    .certFile("/path/to/ca.crt")
    .connect();