Skip to content

Commit

Permalink
Adapt docs and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
LukasFehring authored and tornede committed Apr 17, 2024
1 parent 613d4f5 commit 63f9a4a
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Feature
- Added logging whenever a sql statement is executed.
- Update CI such that the tests are run on Python 3.9 and 3.10, additionally removed the paper draft action.
- Added logging when initializing database to contain resultfields and logfields.
- Adapt ssh tunnel usage to be more flexible and user friendly.

Fix
---
Expand Down
2 changes: 1 addition & 1 deletion docs/source/usage/database_credential_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Below is an example of a database credential file, that connects to a server wit
server: example.mysqlserver.com
However, for security reasons, databases might only be accessible from a specific IP address. In these cases, one can use an ssh jumphost. This means that ``PyExperimenter`` will first connect to the ssh server
that has access to the database and then connect to the database server from there. This is done by adding an additional ``Ssh`` section to the database credential file.
that has access to the database and then connect to the database server from there. This is done by adding an additional ``Ssh`` section to the database credential file, and can be activated either by a PyExperimenter keyword argument or in the :ref:`experimenter configuration file <_experiment_configuration_file>`.
The following example shows how to connect to a database server using an SSH server with the address ``ssh_hostname`` and the port ``optional_ssh_port``.

.. code-block:: yaml
Expand Down
1 change: 1 addition & 0 deletions docs/source/usage/experiment_configuration_file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The experiment configuration file is primarily used to define the database backe
Database:
provider: sqlite
database: py_experimenter
use_ssh_tunnel: False (Optional Parameter; Defautls to False)
table:
name: example_general_usage
keyfields:
Expand Down

0 comments on commit 63f9a4a

Please sign in to comment.