Skip to content

Commit 4f2c26e

Browse files
committed
Merge branch 'readme-new' into 'master'
Refresh README See merge request postgres-ai/database-lab!320
2 parents 5a83b55 + 58717ab commit 4f2c26e

File tree

1 file changed

+23
-39
lines changed

1 file changed

+23
-39
lines changed

README.md

Lines changed: 23 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -2,52 +2,34 @@
22

33
<img src="./assets/db-lab.png" align="right" border="0" />
44

5-
Database Lab Engine (DLE) is an open-source technology that allows blazing-fast cloning of Postgres databases of any size in seconds. This helps solve many problems such as:
6-
- help build dev/QA/staging environments involving full-size production-like databases,
5+
Database Lab Engine (DLE) is an open-source (AGPLv3) technology that allows blazing-fast cloning of Postgres databases of any size in seconds. This helps solve many problems such as:
6+
- build dev/QA/staging environments involving full-size production-like databases,
77
- provide temporary full-size database clones for SQL query analysis optimization (see [Joe bot](https://gitlab.com/postgres-ai/joe)),
8-
- automatically verify database migrations (DB schema changes) and massive data operations to avoid downtime and performance bottlenecks.
8+
- automatically verify database migrations (DB schema changes) and massive data operations in CI/CD pipelines to minimize risks of downtime and performance degradation.
99

10-
As an example, cloning of 10 TiB PostgreSQL database takes less than 2 seconds.
10+
As an example, cloning a 10 TiB PostgreSQL database can take less than 2 seconds.
1111

1212
Read more at [Postgres.ai](https://postgres.ai) and in [the Docs](https://postgres.ai/docs).
1313

14-
> Please support the project giving a GitLab star! It's on [the main page](https://gitlab.com/postgres-ai/database-lab), at the upper right corner:
15-
>
16-
> ![Add a star](./assets/star.gif)
17-
18-
## Installation
19-
See the Database Lab tutorials:
14+
## Useful links
15+
### Tutorials
2016
- [Database Lab tutorial for any PostgreSQL database](https://postgres.ai/docs/tutorials/database-lab-tutorial)
2117
- [Database Lab tutorial for Amazon RDS](https://postgres.ai/docs/tutorials/database-lab-tutorial-amazon-rds)
22-
23-
The latest stable Docker images are published in [the Docker Hub repository](https://hub.docker.com/r/postgresai/dblab-server).
24-
25-
## Client CLI
26-
### Installation
27-
Install Database Lab client CLI on your Linux machine (e.g., Ubuntu):
28-
```bash
29-
curl https://gitlab.com/postgres-ai/database-lab/-/raw/master/scripts/cli_install.sh | bash
30-
```
31-
32-
### Activate CLI autocompletion:
33-
```bash
34-
sudo curl https://gitlab.com/postgres-ai/database-lab/-/raw/master/scripts/bash_autocomplete --output /etc/bash_completion.d/dblab
35-
source /etc/bash_completion.d/dblab
36-
```
37-
38-
### How to use CLI
18+
### Reference guides
19+
- [DLE components](https://postgres.ai/docs/reference-guides/database-lab-engine-components)
20+
- [DLE configuration reference](https://postgres.ai/docs/database-lab/config-reference)
21+
- [DLE API reference](https://postgres.ai/swagger-ui/dblab/)
22+
- [Client CLI reference](https://postgres.ai/docs/database-lab/cli-reference)
23+
### How-to guides
24+
- [How to install Database Lab with Terraform on AWS](https://postgres.ai/docs/how-to-guides/administration/install-database-lab-with-terraform)
3925
- [How to install and initialize Database Lab CLI](https://postgres.ai/docs/guides/cli/cli-install-init)
40-
- [Database Lab Client CLI reference (`dblab`)](https://postgres.ai/docs/database-lab/cli-reference)
41-
42-
## Docker Hub
43-
- [Server](https://hub.docker.com/r/postgresai/dblab-server)
44-
- [CLI client](https://hub.docker.com/r/postgresai/dblab)
45-
- [Extended Docker Images for PostgreSQL – include tons of extensions](https://hub.docker.com/r/postgresai/extended-postgres)
46-
47-
## References
48-
- [Database Lab Engine configuration reference](https://postgres.ai/docs/database-lab/config-reference)
49-
- [API reference](https://postgres.ai/swagger-ui/dblab/)
50-
- [CLI reference](https://postgres.ai/docs/database-lab/cli-reference)
26+
### Miscellaneous
27+
- [DLE Docker images](https://hub.docker.com/r/postgresai/dblab-server)
28+
- [Extended Docker images for PostgreSQL (with plenty of extensions)](https://hub.docker.com/r/postgresai/extended-postgres)
29+
- [SQL Optimization chatbot (Joe Bot)](https://postgres.ai/docs/joe-bot)
30+
- [DB Migration Checker](https://postgres.ai/docs/db-migration-checker)
31+
- [Case Study: How Qiwi Controls the Data to Accelerate Development](https://postgres.ai/resources/case-studies/qiwi)
32+
- [Case Study: How GitLab iterates on SQL performance optimization workflow to reduce downtime risks](https://postgres.ai/resources/case-studies/gitlab)
5133

5234
## Development
5335
Open [an Issue](https://gitlab.com/postgres-ai/database-lab/-/issues) to discuss ideas, open [a Merge Request](https://gitlab.com/postgres-ai/database-lab/-/merge_requests) to propose a change.
@@ -65,6 +47,8 @@ See our [GitLab Container Registry](https://gitlab.com/postgres-ai/database-lab/
6547

6648
## Community
6749
- [Community Slack (English)](https://slack.postgres.ai)
68-
- [Telegram (Russian)](https://t.me/databaselabru)
6950
- [Twitter](https://twitter.com/Database_Lab)
7051

52+
> Please support the project giving a GitLab star! It's on [the main page](https://gitlab.com/postgres-ai/database-lab), at the upper right corner:
53+
>
54+
> ![Add a star](./assets/star.gif)

0 commit comments

Comments
 (0)