How to start using Bytebase for team database collaboration

Photo by Mark König on Unsplash

How to start using Bytebase for team database collaboration

DBA's guide to configuring Bytebase for an existing project

Adela's photo
Adela
·Apr 27, 2022·

2 min read

Table of contents

  • Environment
  • Instance
  • Project

Suppose you are a DBA / Database Administrator (or other roles related to database) and want to try Bytebase with an existing project to increase the efficiency of database team collaboration and decrease the possibility of a database outage. After installing it, what should you do?

Short answer: Prepare a project for the team, and this article will give you the answer in detail.

If you already have 1. an up-running Bytebase and 2. a working database, you can move forward.

If not, my previous articles might help you prepare:

Environment

Real-life pipelines are usually more complex with more environments, e.g., test/stage/.../prod; here, we simplify them into Test and Prod.

image.png

image.png

The default setting is enough for me; you can make adjustments to fit your needs:

  • No manual approvals are required on Test - developers can run SQLs without DBAs' permission. DBAs only review queries if they're going to execute on Prod.
  • Weekly backup on Prod.

Instance

Database Instance or simply Instance models after a single database instance are usually accessed via a host:port address. In our case, 2 AWS RDS MySQLs. image.png

Back to Bytebase, we click Instances -> Add Instance.

image.png image.png

image.png

After filling in the data, our first instance is ready.

image.png

Then we repeat the process. Instances for Test and Prod are ready.

image.png

If databases on AWS are updated, you can always sync them by clicking the button or waiting for the next round of auto checks.

image.png

Project

Project here is similar to the project concept in other dev tools such as Jira, GitLab. It's the container to group logically related Databases, Issues, and Users.

image.png

Let's choose Standard this time.

image.png

There are shortcuts categorized by database/project on the left menu. You can also do bookmarks.

image.png

As the above screenshot suggests, let's click "Transfer in DB" to fill the empty project with some databases. image.png

image.png

Finish, and you can view the databases and history. image.png

Last but not least, under settings within a specific project - in our case, Employee, you can now invite your project owners(usually the DBA who's reviewing SQLs) and developers from your team!

image.png

image.png

image.png

Hooray! It's all set now!

 
Share this