Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update database.rst #1713

Merged
merged 2 commits into from
Apr 14, 2022
Merged

Update database.rst #1713

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4acb207
Update database.rst
lylynaheng Apr 8, 2022
d1f53cb
Merge branch 'main' into patch-6
sgoggins Apr 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/source/getting-started/database.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,25 @@ Database setup
===============

One of the reasons that Augur is so powerful is because of its `unified data model <../schema/data-model.html>`_.
In order to ensure this data model remains performant with large amounts of data, we use PostgreSQL as our database engine.
To ensure this data model remains performant with large amounts of data, we use PostgreSQL as our database engine.
We'll need to set up a PostgreSQL instance and create a database, after which Augur can take care of the rest.
Make sure to save off the credentials you use when you create the database, you'll need them again to configure Augur.
Make sure to save off the credentials you use when creating the database; you'll need them again to configure Augur.

PostgreSQL Installation
~~~~~~~~~~~~~~~~~~~~~~~~

Before you can install our schema, you will need to make sure you have write access to a PostgreSQL 10 or later database. If you're looking for the fastest possible way to get Augur started, we recommend use our `database container <../docker/docker.html>`_. If you're looking to collect data long term, we recommend following the rest of this tutorial and setting up a persistent PostgreSQL installation.
Before you can install our schema, you will need to make sure you have access to a PostgreSQL 10 or later database. If you're looking for the fastest possible way to get Augur started, we recommend using our `database container <../docker/docker.html>`_. If you're looking to collect data long-term, we recommend following the rest of this tutorial and setting up a persistent PostgreSQL installation.

.. warning::

If you want to collect data over the long term, we strongly advise against `using a Docker container for your database <https://vsupalov.com/database-in-docker/>`_.

If you're a newcomer to to PostgreSQL, you can follow their excellent instructions `here <https://www.postgresql.org/docs/12/tutorial-install.html>`_ to set it up for your machine of choice. We recommend using ``Postgres.app`` if you're on macOS, but if you're running UNIX or are looking for an alternative to ``Postgres.app`` then pgAdmin is a great open source alternative.
If you're a newcomer to PostgreSQL, you can follow their excellent instructions `here <https://www.postgresql.org/docs/12/tutorial-install.html>`_ to set it up for your machine of choice. We recommend using ``Postgres.app`` if you're on macOS, but if you're running UNIX or are looking for an alternative to ``Postgres.app`` then pgAdmin is a great open-source alternative.

Creating a Database
~~~~~~~~~~~~~~~~~~~~~

After you've setup your PostgreSQL instance, you'll need to create a database and user with the correct permissions. You can do this with the SQL commands below, but be sure to change the password!
After you set up your PostgreSQL instance, you'll need to create a database and user with the correct permissions. You can do this with the SQL commands below, but be sure to change the password!

.. code-block:: postgresql

Expand All @@ -43,4 +43,4 @@ Then, once you've connected to your PostgreSQL instance\:
postgres=# GRANT ALL PRIVILEGES ON DATABASE augur TO augur;


Once you've got the database setup, Augur will take care of installing the schema for you. You're now ready to `install Augur <installation.html>`_!
Once you've got the database setup, Augur will install the schema for you. You're now ready to `install Augur <installation.html>`_!