👤 This documentation is intended for Site Administrators and/or Database Administrators.
SSL JDBC Connection
The easiest way to connect to a database to Periscope is through an SSL JDBC connection. Below is what is needed to get connected.
Database Name or S3 Staging Directory (Athena)
This is the name of the database as it is configured on the database
Databases connect slightly differently depending on their types so it is important to select the correct database type when connecting a database.
Database Host or Account Name (Snowflake)
The database host is the web address at which Periscope can find the database. The database host needs to be publicly accessible via the internet and accepting connections from the Periscope IP
For Snowflake databases which decouple storage from computation, a warehouse needs to be specified for query processing. Once the specified, Periscope will continue to use the same warehouse to run every query.
Each database type has a default port through which it accepts connections. If the database has not been configured to use a special port, it is likely accepting connections through these ports:
- MySQL: 3306
- Postgres: 5432
- Redshift: 5439
- Vertica: 5433
- SQL Server: 1433
- Oracle: 1521
- MemSQL: 3306
- Sybase: 5000
- Exasol: 8563
Database Username & Password
This is the username and the corresponding password that Periscope will connect to the database with. Periscope currently supports password authentication to a database and cannot accept connections utilizing public key authentication. It is recommended that a user is created specifically for Periscope to access the database.
SSH Tunnel Connections
These connection credentials are required if the database is sitting within a private network or behind a firewall.
While all other connection components will remain the same as an SSL JDBC connection when connecting using SSH, the database host will now be an internal address that does not have to be publicly accessible.
This is the public facing URL or IP address of the server that is listening for SSH connections.
This is the username that has been created on the SSH host at the operating system level that has been authorized with the Periscope public key. For more information on setting up the SSH host, check out Periscope's Private Network SSH Tunnels docs.
The default SSH port is 22, but if the SSH host server is configured to listen for SSH connections on a different port, that should be entered instead.