Releases: bytebase/bytebase
Release 3.10.0
π New Features
- Cassandra - support data masking.
- Add TLS certificate verification toggle while adding instance.
π Notable Changes
- Service accounts no longer contribute to user usage metrics.
- API β Deprecate
SQL_RESULT_SIZE_LIMIT
setting andDATA_EXPORT
policy. ConsolidatedSQLQueryRestrictionSetting
andExportDataPolicy
into theDATA_QUERY
policy. - Terraform β Deprecate
sql_query_restriction
setting. Use thequery_data_policy
block instead, which supportsdisable_export
,maximum_result_rows
,maximum_result_size
, andtimeout_in_seconds
.
π Enhancements
- Bytebase Cloud - Gemini AI is enabled automatically in the SaaS mode - Totally FREE!
- Bytebase GitHub Actions (bytebase-action) -
rollout
command now outputs a job summary on GitHub. Example - Improve database creation page for clearer information.
π Bug Fix
- SQL Server - Fix cross-database reference issues in queries.
Warning 1): Bytebase does not support in-place downgrade. Make sure to back up your metadata before upgrading. 2) Never run multiple containers on the same data directory. Stop and remove the old one first to avoid corruption.
Release 3.9.2
π New Features
- Add support for hard-delete of projects and instances (resources must be archived first).
- Add support for adding/removing changes in draft plans.
π Notable Changes
- Streamline approval by enabling one-click ready for review.
- Update
UpdateMask
values inUpdatePolicy
to observe AIP. Use field names only; oneof type names are omitted. (PR #17240) - Terraform - Deprecate
column
,member
andaction
field in themasking_exception_policy
, usecolumns
,members
andactions
instead. Example: data_masking.tf
π Enhancements
- Add support for empty environments in instance and database resources.
- Enhance SQL Editor performance.
- Entra ID - Normalize SCIM user emails to lowercase for authentication.
- PostgreSQL - Add support for
CREATE RULE
. - API - Add support for pagination and filtering for group API.
- Terraform - Add support for
raw_expression
in themasking_exception_policy
. Once provided, it is used as the CEL expression, and all other (database
,schema
,table
,columns
,expire_timestamp
) fields are ignored. - Terraform - Add support for empty environments in instance and database resources.
- Terraform - Add support for filters in group list data sources.
Warning 1): Bytebase does not support in-place downgrade. Make sure to back up your metadata before upgrading. 2) Never run multiple containers on the same data directory. Stop and remove the old one first to avoid corruption.
Release 3.9.1
π New Features
- Support importing database revisions from releases or local files.
- Support reading
PG_URL
from a file with hot-reload. - Support IAM authentication for AWS OpenSearch.
π Notable Changes
- Service accounts will no longer be able to log in via the Bytebase GUI.
πͺ¦ Sunset
-
Remove the deprecated
--pg
command-line flag. Use thePG_URL
environment variable for external PostgreSQL connections instead. -
Replace the
--disable-metric
flag with a Workspace setting. -
Remove the
--disable-sample
flag.
π Enhancements
-
Bytebase GitHub Actions will now try to reuse existing releases before creating new ones. If two releases have the same filenames and file contents, they are considered identical, reducing redundant releases when retrying.
-
Terraform β Add support to configure masking exceptions for all databases by skipping database, table, and column, applying the exception across the entire project.
-
Terraform β Add support for the
sync_databases
attribute in the instance resource, allowing you to specify which databases to sync (e.g.,["db1", "db2"]
).
Warning 1): Bytebase does not support in-place downgrade. Make sure to back up your metadata before upgrading. 2) Never run multiple containers on the same data directory. Stop and remove the old one first to avoid corruption.
Release 3.9.0
π New Database CI/CD Experience
New database CI/CD experience is now enabled by default. The new layout splits a monolithic page into dedicated tabs for clearer information display and efficient batch change management:
- Overview tab displays general change details and approval status
- Changes tab lists database changes and their targets
- Rollout tab manages the deployment process
- In addition to the layout update, the new design also introduces the following new features:
- Multi-task rollback.
- Plan draft to stage changes.
Users can still switch back to the old layout via the profile dropdown in the top-right corner.
Changelog
Warning 1): Bytebase does not support in-place downgrade. Make sure to back up your metadata before upgrading. 2) Never run multiple containers on the same data directory. Stop and remove the old one first to avoid corruption.
Release 3.8.1
π Notable Changes
- New database CI/CD experience is available in preview. Enable it from the profile dropdown.
default_expression
,default_string
, anddefault_null
fields inColumnMetadata
are removed from the API. Use the unifieddefault
field instead. This affects APIs such asGetDatabaseMetadata
andGetChangelog
.
π New Features
- In SQL Editor and audit log, show masking reason for sensitive data.
π Enhancements
- Data export files are available for 24 hours and can be downloaded unlimited times during that period.
- SQL Server - Support Spatial Index in schema rollback and synchronization.
- Redshift - Support turning off transaction wrapping using the
-- txn-mode=off
directive before the SQL statement. - Terraform - Support more policies:
- rollout policy (for environments)
- copy data policy (for environments and projects)
- data source query policy (for environments and projects)
- See example configurations.
- Introduce a new 8-part series of Terraform Provider Tutorials.
Changelog
Warning 1): Bytebase does not support in-place downgrade. Make sure to back up your metadata before upgrading. 2) Never run multiple containers on the same data directory. Stop and remove the old one first to avoid corruption.
Release 3.8.0
π Notable Changes
- Greatly improve schema sync/rollback for MySQL/PostgreSQL/TiDB/SQL Server/Oracle compatibility, supporting most common database objects.
- Sunset Issue Subscription feature.
- Rename Review Center to Plans.
π Enhancements
- Add query result row limit support.
- Add multi-domain configuration support.
- Simplify default value input: No longer distinguish between expressions and values, but unify them into a text input field.
- List all approvers on approval workflow, and display details on hover.
π Bug Fixes
- Fix JSON data type display issue for ClickHouse queries.
- Add
use_ssl
field to Terraform SSL configuration.
Changelog
Warning: Bytebase does not support downgrade. Make sure to back up your meta data before upgrading.
Release 3.7.1
π Notable Changes
- All database change features are now FREE in Community Plan! See full details in our updated pricing.
π Enhancements
- Overhaul docs site with improved navigation, search, and Ask AI.
- SQL Editor now highlights the statement under the cursor.
- Renovate Review Center with a refreshed UI and better user experience. Review Center routes have changed from
/review-center
to/plans
. - Streamline SSO creation flow for easier configuration.
- Terraform - Add support for applying SSL certificates to database connections via the new
use_ssl
field.
π Bug Fixes
- Database Access Control now properly handles case-sensitive object names.
- MySQL - Fix an issue when creating procedures via Schema Editor.
- OceanBase - Fix 2 SQL Review rules:
- Enforce maximum number of updated or deleted rows
- Enforce maximum number of inserted rows
Changelog
Warning: Bytebase does not support downgrade. Make sure to back up your meta data before upgrading.
Release 3.7.0
π New Features
- Support batch data export from multiple databases or a database group via issue.
- Support batch data export from limited databases in the SQL Editor.
- Support requesting any project roles.
- Support displaying
CHECK
constraints in the SQL Editor. - Trino - Support data masking.
- MariaDB - Support sql_type in risk condition.
- SQL Server - Support columnstore index.
π Breaking Changes
π° Pricing
- Custom approval is no longer restricted by instance limits. It now only requires an Enterprise subscription. Previously, it was limited to licensed instances β now it applies to any instance under an Enterprise plan.
π¨ GUI
-
Remove Earliest allowed time. Use Scheduled time during rollout instead.
-
The gh-ost and backup toggles are now set at the issue level, no longer at the task level.
-
The SQL statement is now defined at the issue level, no longer at the task level. Once a task has started or completed, the statement cannot be updated.
π§© API
-
Remove
earliest_allowed_time
fromPlan.spec
. Userun_at
inBatchRunTasksRequest
instead. -
Remove
steps
andtarget
fromPlan
. Usespecs
andtargets
respectively. -
Remove
PreviewPlan
RPC fromPlanService
. -
Update
ChangeDatabaseConfig
:- Remove
BASELINE
fromType
. - Remove
schema_version
. - Add
release
.
- Remove
-
Update setting names, use the correct values as defined in SettingName.
π Enhancements
- PostgreSQL - Issue tickets now honor any supplied
SET search_path
, so subsequent SQL statements (and their DML rollback logic) operate on the specified schema rather than defaulting to public. - Trino - Enhance auto-completion support.
- TiDB - Improve syntax error detection.
- TiDB - The "require primary key" rule now checks the source table when using
CREATE TABLE LIKE
.
π Bug Fixes
- Doris and StarRocks - Resolve compatibility issues.
- RedShift - Fix connection database parameter issue.
Changelog
Warning: Bytebase does not support downgrade. Make sure to back up your meta data before upgrading.
Release 3.6.2
π New Features
- Enhance SQL Editor experience.
- Support database group in the batch query.
- Store the query result history. The history is only stored in the browser locally.
- Lazy query. Only execute the query request on-demand when users click the tab.
- Display SQL Server trigger body in SQL Editor.
π Enhancements
- Implement semantic versioning for GitOps.
Changelog
Warning: Bytebase does not support downgrade. Make sure to back up your meta data before upgrading.
Release 3.6.1
π New Features
- DML rollback supports unique indexes for MySQL, PostgreSQL, Oracle and MSSQL.
- Improve wizard for initial workspace creation.
- Introduce Parallel tasks per rollout and CI Data Sampling Size options in project settings.
π Enhancements
- Allow removal of any roles β including
workspace member
β from any workspace user, includingallUser
. - Support setting custom expiration days when granting project roles.
π Bug Fix
- Fix PostgreSQL schema autocomplete for names with special characters.
Changelog
Warning: Bytebase does not support downgrade. Make sure to back up your meta data before upgrading.