This driver supports using openCypher for executing statements against Neptune.
The connection string for openCypher connections follows the following form:
jdbc:neptune:opencypher://bolt://[host]:[port];[propertyKey1=value1];[propertyKey2=value2]..;[propertyKeyN=valueN]
Note: For openCypher, the port must be specified as a part of the connection string not as a propertyKey. Property useEncryption must be set to true (defaults to true). The host must also be prefixed with //bolt: to specify usage of the Bolt connector.
The following properties are available for openCypher:
| Property Key | Description | Accepted Value(s) | Default value |
|---|---|---|---|
| logLevel | Log level for application. | In order of least logging to most logging: OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL. |
INFO |
| authScheme | Authentication mechanism to use. | NONE (no auth), IAMSigV4 (IAM / SIGV4 logging). |
IAMSigV4, AWS SIGV4 credentials must be properly set up, including a region. See environment setup for IAM authentication on Neptune for more information. |
| serviceRegion | If IAMSigv4 is selected, this region variable must be set for connecting to IAM authenticated Neptune instance |
String values. For example, us-east-1 |
NONE. For a list of regions see Neptune service regions. An alternative to setting this is through exporting the SERVICE_REGION environment variable as instructed in the link. |
| connectionTimeout | Amount of time to wait for initial connection in milliseconds. | Integer values. | 5000 |
| connectionRetryCount | Number of times to retry if establishing initial connection fails. | Integer values. | 3 |
| connectionPoolSize | The max size of the connection pool to establish with the cluster. | Integer values. | 1000 |
| useEncryption | Whether to establish the connection over SSL/TLS. | true or false. |
Default value is true. |
| region | The AWS endpoint region to connect to. | Valid AWS regions such as, but not limited to, us-east-1, us-west-1. |
Default value is whatever is configured in the user's AWS SIG4 credentials. |
| sshUser | The username for the internal SSH tunnel. If provided, options sshHost and sshPrivateKeyFile must also be provided, otherwise this option is ignored. |
String values. | NONE |
| sshHost | The host name for the internal SSH tunnel. Optionally the SSH tunnel port number can be provided using the syntax <ssh-host>:<port>. The default port is 22. If provided, options sshUser and sshPrivateKeyFile must also be provided, otherwise this option is ignored. |
String values. | NONE |
| sshPrivateKeyFile | The path to the private key file for the internal SSH tunnel. If the path starts with the tilde character (~), it will be replaced with the user's home directory. If provided, options sshUser and sshHost must also be provided, otherwise this option is ignored. |
String values. | NONE |
| sshPrivateKeyPassphrase | If the SSH tunnel private key file, sshPrivateKeyFile, is passphrase protected, provide the passphrase using this option. If provided, options sshUser, sshHost and sshPrivateKeyFile must also be provided, otherwise this option is ignored. |
String values. | NONE |
| sshStrictHostKeyChecking | If true, the 'known_hosts' file is checked to ensure the target host is trusted when creating the internal SSH tunnel. If false, the target host is not checked. Disabling this option is less secure as it can lead to a "man-in-the-middle" attack. If provided, options sshUser, sshHost and sshPrivateKeyFile must also be provided, otherwise this option is ignored. |
Boolean values. | true |
| sshKnownHostsFile | The path to the 'known_hosts' file used for checking the target host for the SSH tunnel when option sshStrictHostKeyChecking is true. The 'known_hosts' file can be populated using the ssh-keyscan tool. If provided, options sshUser, sshHost and sshPrivateKeyFile must also be provided, otherwise this option is ignored. |
String values. | ~/.ssh/known_hosts |
import java.sql.*;
class Example {
static final String CONNECTION_STRING = "jdbc:neptune:opencypher://bolt://example.neptune.amazonaws.com:8182;authScheme=None;useEncryption=true";
public static void main(String[] args) throws SQLException {
Connection connection = DriverManager.getConnection(CONNECTION_STRING);
connection.close();
}
}Instead of having properties set in the connection string, you can also set Properties in order to get a connection.
import java.sql.*;
import java.util.Properties;
class Example {
static final String CONNECTION_STRING = "jdbc:neptune:opencypher://bolt://example.neptune.amazonaws.com:8182";
public static void main(String[] args) throws SQLException {
Properties properties = new Properties();
properties.put("authScheme", "None");
properties.put("useEncryption", true);
Connection connection = DriverManager.getConnection(CONNECTION_STRING, properties);
connection.close();
}
}IAM is the standard way to access Neptune under an authorized account.
import java.sql.*;
class Example {
static final String CONNECTION_STRING = "jdbc:neptune:opencypher://bolt://example.neptune.amazonaws.com:8182;authScheme=IAMSigV4;useEncryption=true;serviceRegion=us-east-1";
public static void main(String[] args) throws SQLException {
Connection connection = DriverManager.getConnection(CONNECTION_STRING);
connection.close();
}
}Like above, Properties can be used to set the settings to enable IAM authentication.
import java.sql.*;
import java.util.Properties;
class Example {
static final String CONNECTION_STRING = "jdbc:neptune:opencypher://bolt://example.neptune.amazonaws.com:8182";
public static void main(String[] args) throws SQLException {
Properties properties = new Properties();
properties.put("authScheme", "IAMSigV4");
properties.put("serviceRegion", "us-east-1");
properties.put("useEncryption", true);
Connection connection = DriverManager.getConnection(CONNECTION_STRING, properties);
connection.close();
}
}import java.sql.*;
class Example {
static final String CONNECTION_STRING = "jdbc:neptune:opencypher://bolt://example.neptune.amazonaws.com:8182;authScheme=None;useEncryption=true";
public static void main(String[] args) throws SQLException {
// Create a connection
try (Connection connection = DriverManager.getConnection(CONNECTION_STRING)) {
// Get the MetaData of the database
DatabaseMetaData metaData = connection.getMetaData();
// Get the tables from the MetaData
try (ResultSet results = metaData.getTables(null, null, "%", null)) {
while (results.next()) {
// Get the table name from the results and print them
String tableName = results.getString("TABLE_NAME");
System.out.println(tableName);
}
}
}
}
}import java.sql.*;
class Example {
static final String CONNECTION_STRING = "jdbc:neptune:opencypher://bolt://example.neptune.amazonaws.com:8182;authScheme=None;useEncryption=true";
public static void main(String[] args) throws SQLException {
String query = "MATCH (c:country) RETURN c.desc";
try (
// Create a connection
Connection connection = DriverManager.getConnection(CONNECTION_STRING);
// Create a statement
Statement statement = connection.createStatement();
// Execute a query
ResultSet results = statement.executeQuery(query)
) {
while (results.next()) {
// Get the queried country name from the results and print them
String countryName = results.getString(1);
System.out.println(countryName);
}
}
}
}