Skip to content

Update PostgreSQL user permission in Usage Guide #593

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

Merged
merged 1 commit into from
Mar 10, 2023
Merged

Update PostgreSQL user permission in Usage Guide #593

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions doc/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ psql
In the PostgreSQL command-line shell, type:

```sql
CREATE USER compass WITH SUPERUSER LOGIN PASSWORD '<mypassword>';
CREATE USER compass WITH CREATEDB LOGIN PASSWORD '<mypassword>';
```

You can exit this shell by typing `\q` and pressing the `ENTER` key. A user
Expand All @@ -47,9 +47,9 @@ with the given name and credentials is now created.
This was the most basic way to set up access to the database. In case of a live,
production, public server, certain other measures need to be taken to ensure
secure access. For full documentation, see:
- Read more about the [`CREATE USER`](https://www.postgresql.org/docs/9.5/static/sql-createuser.html)
- Read more about the [`CREATE USER`](https://www.postgresql.org/docs/12/sql-createuser.html)
command.
- [PostgreSQL access configuration file](https://www.postgresql.org/docs/9.5/static/auth-pg-hba-conf.html)
- [PostgreSQL access configuration file](https://www.postgresql.org/docs/12/auth-pg-hba-conf.html)

The databases inside PostgreSQL instance will be created automatically by the
CodeCompass parser, so the user needs rights for adding new database.
Expand All @@ -70,9 +70,9 @@ A manually started PostgreSQL server is automatically configured to your user,
and your user only. No extra user creation or configuration needs to take place.

For full documentation see:
- [Initialize PostgreSQL database](https://www.postgresql.org/docs/9.5/static/app-initdb.html)
- [Initialize PostgreSQL database](https://www.postgresql.org/docs/12/app-initdb.html)
(`-E SQL_ASCII` flag is recommended!)
- [Start PostgreSQL database](https://www.postgresql.org/docs/9.5/static/app-postgres.html)
- [Start PostgreSQL database](https://www.postgresql.org/docs/12/app-postgres.html)

## 1. Generate compilation database
If you want to parse a C++ project, you have to create a [compilation database
Expand Down