Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

10.5 KB
Raw Blame
//nolint:revive
package common

import (
	storepb "github.com/bytebase/bytebase/backend/generated-go/store"
)

func EngineSupportSQLReview(engine storepb.Engine) bool {
	//exhaustive:enforce
	switch engine {
	case
		storepb.Engine_POSTGRES,
		storepb.Engine_MYSQL,
		storepb.Engine_TIDB,
		storepb.Engine_MARIADB,
		storepb.Engine_ORACLE,
		storepb.Engine_OCEANBASE,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_REDSHIFT,
		storepb.Engine_MSSQL,
		storepb.Engine_BIGQUERY:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_CASSANDRA,
		storepb.Engine_MONGODB,
		storepb.Engine_REDIS,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_SPANNER,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_DORIS,
		storepb.Engine_DYNAMODB,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO:
		return false
	default:
		return false
	}
}

// EngineSupportSDLExport reports whether GetDatabaseSDLSchema can produce an SDL dump
// for the engine. Only engines with an SDL-format definition writer AND the multi-file
// exporter registered qualify. OceanBase shares MySQL's GetDatabaseDefinition (and thus
// its single-file SDL branch) but is deliberately excluded from the SDL paths until it is
// validated, so it must be rejected here too rather than emitting an untested SDL dump.
func EngineSupportSDLExport(engine storepb.Engine) bool {
	//exhaustive:enforce
	switch engine {
	case
		storepb.Engine_POSTGRES,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_MYSQL:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_CASSANDRA,
		storepb.Engine_MONGODB,
		storepb.Engine_REDIS,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_SPANNER,
		storepb.Engine_BIGQUERY,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_ORACLE,
		storepb.Engine_MSSQL,
		storepb.Engine_TIDB,
		storepb.Engine_MARIADB,
		storepb.Engine_OCEANBASE,
		storepb.Engine_REDSHIFT,
		storepb.Engine_DORIS,
		storepb.Engine_DYNAMODB,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO:
		return false
	default:
		return false
	}
}

func EngineSupportQueryNewACL(engine storepb.Engine) bool {
	//exhaustive:enforce
	switch engine {
	case
		storepb.Engine_MYSQL,
		storepb.Engine_POSTGRES,
		storepb.Engine_ORACLE,
		storepb.Engine_MSSQL,
		storepb.Engine_TIDB,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_SPANNER,
		storepb.Engine_BIGQUERY,
		storepb.Engine_MONGODB,
		storepb.Engine_ELASTICSEARCH:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_CASSANDRA,
		storepb.Engine_REDIS,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_OCEANBASE,
		storepb.Engine_MARIADB,
		storepb.Engine_REDSHIFT,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_DORIS,
		storepb.Engine_DYNAMODB,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO:
		return false
	default:
		return false
	}
}

func EngineSupportMasking(e storepb.Engine) bool {
	//exhaustive:enforce
	switch e {
	case
		storepb.Engine_MYSQL,
		storepb.Engine_POSTGRES,
		storepb.Engine_ORACLE,
		storepb.Engine_MSSQL,
		storepb.Engine_MARIADB,
		storepb.Engine_OCEANBASE,
		storepb.Engine_TIDB,
		storepb.Engine_BIGQUERY,
		storepb.Engine_SPANNER,
		storepb.Engine_REDSHIFT,
		storepb.Engine_CASSANDRA,
		storepb.Engine_TRINO,
		storepb.Engine_SNOWFLAKE:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_MONGODB,
		storepb.Engine_REDIS,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_DORIS,
		storepb.Engine_DYNAMODB,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB:
		return false
	default:
		return false
	}
}

func EngineSupportAutoComplete(e storepb.Engine) bool {
	//exhaustive:enforce
	switch e {
	case
		storepb.Engine_MYSQL,
		storepb.Engine_TIDB,
		storepb.Engine_MARIADB,
		storepb.Engine_OCEANBASE,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_STARROCKS,
		storepb.Engine_DORIS,
		storepb.Engine_POSTGRES,
		storepb.Engine_REDSHIFT,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_MSSQL,
		storepb.Engine_ORACLE,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_DYNAMODB,
		storepb.Engine_TRINO,
		storepb.Engine_MONGODB:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_CASSANDRA,
		storepb.Engine_REDIS,
		storepb.Engine_SPANNER,
		storepb.Engine_BIGQUERY,
		storepb.Engine_HIVE,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB:
		return false
	default:
		return false
	}
}

func EngineSupportStatementAdvise(e storepb.Engine) bool {
	//exhaustive:enforce
	switch e {
	case
		storepb.Engine_MYSQL,
		storepb.Engine_TIDB,
		storepb.Engine_POSTGRES,
		storepb.Engine_ORACLE,
		storepb.Engine_OCEANBASE,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_MSSQL,
		storepb.Engine_DYNAMODB,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_REDSHIFT,
		storepb.Engine_MARIADB,
		storepb.Engine_BIGQUERY:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_CASSANDRA,
		storepb.Engine_MONGODB,
		storepb.Engine_REDIS,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_SPANNER,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_DORIS,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO:
		return false
	default:
		return false
	}
}

func EngineSupportStatementReport(e storepb.Engine) bool {
	//exhaustive:enforce
	switch e {
	case
		storepb.Engine_POSTGRES,
		storepb.Engine_MYSQL,
		storepb.Engine_TIDB,
		storepb.Engine_OCEANBASE,
		storepb.Engine_ORACLE,
		storepb.Engine_MSSQL,
		storepb.Engine_MARIADB,
		storepb.Engine_REDSHIFT,
		storepb.Engine_COCKROACHDB:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_CASSANDRA,
		storepb.Engine_MONGODB,
		storepb.Engine_REDIS,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_SPANNER,
		storepb.Engine_BIGQUERY,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_DORIS,
		storepb.Engine_DYNAMODB,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO:
		return false
	default:
		return false
	}
}

func EngineSupportPriorBackup(e storepb.Engine) bool {
	//exhaustive:enforce
	switch e {
	case
		storepb.Engine_MYSQL,
		storepb.Engine_MARIADB,
		storepb.Engine_TIDB,
		storepb.Engine_MSSQL,
		storepb.Engine_ORACLE,
		storepb.Engine_POSTGRES:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_CASSANDRA,
		storepb.Engine_MONGODB,
		storepb.Engine_REDIS,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_SPANNER,
		storepb.Engine_BIGQUERY,
		storepb.Engine_REDSHIFT,
		storepb.Engine_OCEANBASE,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_DORIS,
		storepb.Engine_DYNAMODB,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO:
		return false
	default:
		return false
	}
}

func EngineSupportCreateDatabase(e storepb.Engine) bool {
	//exhaustive:enforce
	switch e {
	case
		storepb.Engine_MYSQL,
		storepb.Engine_POSTGRES,
		storepb.Engine_MSSQL,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_MONGODB,
		storepb.Engine_TIDB,
		storepb.Engine_OCEANBASE,
		storepb.Engine_REDSHIFT,
		storepb.Engine_MARIADB,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_DORIS:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_CASSANDRA,
		storepb.Engine_SPANNER,
		storepb.Engine_BIGQUERY,
		storepb.Engine_DYNAMODB,
		storepb.Engine_REDIS,
		storepb.Engine_ORACLE,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO:
		return false
	default:
		return false
	}
}

func EngineSupportQuerySpanPlainField(e storepb.Engine) bool {
	//exhaustive:enforce
	switch e {
	case
		storepb.Engine_MYSQL,
		storepb.Engine_OCEANBASE,
		storepb.Engine_MARIADB:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_CASSANDRA,
		storepb.Engine_SPANNER,
		storepb.Engine_BIGQUERY,
		storepb.Engine_DYNAMODB,
		storepb.Engine_REDIS,
		storepb.Engine_ORACLE,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO,
		storepb.Engine_POSTGRES,
		storepb.Engine_MSSQL,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_MONGODB,
		storepb.Engine_TIDB,
		storepb.Engine_REDSHIFT,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_DORIS:
		return false
	default:
		return false
	}
}

func EngineSupportSyntaxCheck(e storepb.Engine) bool {
	//exhaustive:enforce
	switch e {
	case
		storepb.Engine_TIDB,
		storepb.Engine_MYSQL,
		storepb.Engine_MARIADB,
		storepb.Engine_OCEANBASE,
		storepb.Engine_POSTGRES,
		storepb.Engine_REDSHIFT,
		storepb.Engine_ORACLE,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_MSSQL,
		storepb.Engine_DYNAMODB,
		storepb.Engine_COCKROACHDB:
		return true
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_CASSANDRA,
		storepb.Engine_MONGODB,
		storepb.Engine_REDIS,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_SPANNER,
		storepb.Engine_BIGQUERY,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_DORIS,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO:
		return false
	default:
		return false
	}
}

func BackupDatabaseNameOfEngine(e storepb.Engine) string {
	//exhaustive:enforce
	switch e {
	case
		storepb.Engine_MYSQL,
		storepb.Engine_MARIADB,
		storepb.Engine_TIDB,
		storepb.Engine_MSSQL,
		storepb.Engine_POSTGRES:
		return "bbdataarchive"
	case
		storepb.Engine_ORACLE:
		return "BBDATAARCHIVE"
	case
		storepb.Engine_ENGINE_UNSPECIFIED,
		storepb.Engine_SNOWFLAKE,
		storepb.Engine_CASSANDRA,
		storepb.Engine_MONGODB,
		storepb.Engine_REDIS,
		storepb.Engine_CLICKHOUSE,
		storepb.Engine_SPANNER,
		storepb.Engine_BIGQUERY,
		storepb.Engine_REDSHIFT,
		storepb.Engine_OCEANBASE,
		storepb.Engine_STARROCKS,
		storepb.Engine_HIVE,
		storepb.Engine_COCKROACHDB,
		storepb.Engine_DORIS,
		storepb.Engine_DYNAMODB,
		storepb.Engine_ELASTICSEARCH,
		storepb.Engine_DATABRICKS,
		storepb.Engine_COSMOSDB,
		storepb.Engine_TRINO:
		// Fallback to the default name for other engines.
		return "bbdataarchive"
	default:
		// Fallback to the default name for other engines.
		return "bbdataarchive"
	}
}