From 4acb207951039d4c7b3fb63b198e431d077a56c9 Mon Sep 17 00:00:00 2001 From: Lylyna Heng Date: Thu, 7 Apr 2022 20:50:16 -0700 Subject: [PATCH] Update database.rst --- docs/source/getting-started/database.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/getting-started/database.rst b/docs/source/getting-started/database.rst index a883de0e63..03ec427a5b 100644 --- a/docs/source/getting-started/database.rst +++ b/docs/source/getting-started/database.rst @@ -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 `_. -If you're a newcomer to to PostgreSQL, you can follow their excellent instructions `here `_ 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 `_ 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 @@ -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 `_! +Once you've got the database setup, Augur will install the schema for you. You're now ready to `install Augur `_!