Announcement

The SQL Editor for Developers and DBAs

Candy
4 min read

Key features of Advanced SQL Editor

With Database DevOps rapidly evolving, application developers and DBAs are involved in database change management. Application developers are responsible for writing SQL statements to apply schema and data change to their databases and view the query results. On the other hand, DBAs ensure that all databases run smoothly, securely, and efficiently by developing various policies and collaborating with application developers to perform the database change.

As we know, SQL Editor is a crucial tool for executing SQL statements and operating databases with admin commands. Compared to the classic SQL tools, such as command line interface and traditional SQL Editor, an advanced SQL Editor for the Database DevOps team should have the following features:

  • User-friendly interface: It should be easy to write, read and execute SQL statements and browse the database schema and query results.
  • Collaboration: It should support team members in saving, sharing, and tracking SQL statements.
  • Security: It should provide features to grant database access to team members with requirements, protect sensitive data when executing queries, control permissions to perform database admin commands, and capture audit logs.

SQL Editor in Bytebase Console

Bytebase v1.9.1 releases a new SQL Editor with the following highlights:

  • Admin mode: Bytebase provides Admin mode in SQL Editor to allow DBAs to execute database admin commands.
  • Database-based access control: All databases in the protected environments can not be queried by developers in SQL Editor. DBAs can configure a database allowlist to grant developers the ability to query some of databases.
  • Data anonymization: The query result of sensitive columns will be masked when developers run a query in SQL Editor. It is applicable to all query types, such as subquery, JOIN, Common Table Expression (CTE).
  • Audit logs: Bytebase Audit Log records all queries in SQL Editor which is accessible to DBAs.
  • Collaborative sheets: DBAs and developers can save SQL statements as sheets to share with others in SQL Editor. Moreover, this release supports saving the uploaded SQL scripts as sheets to be used in issues to apply database changes, a single sheet can hold up to 100MB sized SQL statements.
  • Good user experience: This release presents SQL Editor with a fresh look and improves the code auto-completion.

Admin Mode

When users want to connect to databases to run admin commands, they can do it in SQL Editor Admin mode with a DBA account like the screenshot below. You can take a look at the document Admin Mode to learn more details. admin-mode

Database-based Access Control

When users want to allow developers to access some databases in the production environment, they can mark the production environment as a protected environment and configure an allowlist. You can get more details from the document Database Access Control. access-control

Data Anonymization

When developers query tables containing sensitive columns in SQL Editor, the result of these columns will display as "**". You can learn the configuration details from the document Anonymize Data. anonymize-data

Audit Logs

DBAs can browse all queries executed in SQL Editor with the audit logs. You can check out the document Audit Log to get more details. audit-log

Collaborative Sheets

For commonly-used SQL statements, you can save them as sheets and set up a public SQL script library in your team. For large SQL scripts (up to 100M), you can use them in issues after uploading them as sheets (see the screenshot below). You can explore the document Manage SQL Scripts with Sheet to get additional details. large-script

Try it Out

With the new SQL Editor in Bytebase Console, you can run database admin commands in Admin mode, anonymize sensitive data when fetching query results, configure a database allowlist to manage database access permission, and save commonly-used SQL scripts to collaborate with team members. Besides that, you can inspect all queries in SQL Editor via audit logs.

If you have any comments or questions, don’t hesitate to let us know. You can join our discord to learn more about Bytebase.