Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
import { DATASOURCE_ADMIN_USER_NAME } from "@/types";
import { Engine } from "@/types/proto-es/v1/common_pb";
export type InfoSection =
| "host"
| "port"
| "authentication"
| "ssl"
| "ssh"
| "database"
| "sync-databases";
export type InfoSnippetContentKey =
| "instance.info.mongodb.authentication.content"
| "instance.info.mongodb.host.content"
| "instance.info.mongodb.ssh.content"
| "instance.info.mongodb.ssl.content"
| "instance.info.mysql.authentication.content"
| "instance.info.mysql.host.content"
| "instance.info.mysql.ssh.content"
| "instance.info.mysql.ssl.content"
| "instance.info.postgresql.authentication.content"
| "instance.info.postgresql.host.content"
| "instance.info.postgresql.ssh.content"
| "instance.info.postgresql.ssl.content"
| "instance.info.sync-databases.content";
export type InfoSnippetLinkTitleKey =
| "instance.info.configure-database-user.link"
| "instance.info.connect-instance.link"
| "instance.info.ssh-tunnel.link"
| "instance.info.ssl-tls-connection.link";
export type InfoSnippetWarningKey =
"instance.sentence.create-user-example.mysql.warn";
export type InfoSnippet = {
contentKey: InfoSnippetContentKey;
contentInterpolation?: Record<string, string>;
codeBlock?: {
language: string;
code: string;
};
warning?: {
key: InfoSnippetWarningKey;
url: string;
};
learnMoreLinks?: {
titleKey: InfoSnippetLinkTitleKey;
url: string;
}[];
};
const postgresqlContent: Partial<Record<InfoSection, InfoSnippet>> = {
host: {
contentKey: "instance.info.postgresql.host.content",
learnMoreLinks: [
{
titleKey: "instance.info.connect-instance.link",
url: "https://docs.bytebase.com/get-started/instance?source=console",
},
],
},
authentication: {
contentKey: "instance.info.postgresql.authentication.content",
contentInterpolation: {
user: DATASOURCE_ADMIN_USER_NAME,
},
codeBlock: {
language: "sql",
code: `CREATE USER ${DATASOURCE_ADMIN_USER_NAME} WITH ENCRYPTED PASSWORD 'YOUR_DB_PWD';
ALTER USER ${DATASOURCE_ADMIN_USER_NAME} WITH SUPERUSER;`,
},
learnMoreLinks: [
{
titleKey: "instance.info.configure-database-user.link",
url: "https://docs.bytebase.com/get-started/instance?source=console#configure-a-database-user",
},
],
},
ssl: {
contentKey: "instance.info.postgresql.ssl.content",
learnMoreLinks: [
{
titleKey: "instance.info.ssl-tls-connection.link",
url: "https://docs.bytebase.com/get-started/instance?source=console#ssltls-connection",
},
],
},
ssh: {
contentKey: "instance.info.postgresql.ssh.content",
learnMoreLinks: [
{
titleKey: "instance.info.ssh-tunnel.link",
url: "https://docs.bytebase.com/get-started/instance?source=console#ssh-tunnel",
},
],
},
};
const mysqlAuthentication: InfoSnippet = {
contentKey: "instance.info.mysql.authentication.content",
contentInterpolation: {
user: DATASOURCE_ADMIN_USER_NAME,
},
codeBlock: {
language: "sql",
code: `CREATE USER ${DATASOURCE_ADMIN_USER_NAME}@'%' IDENTIFIED BY 'YOUR_DB_PWD';
GRANT ALTER, ALTER ROUTINE, CREATE, CREATE ROUTINE, CREATE VIEW,
DELETE, DROP, EVENT, EXECUTE, INDEX, INSERT, PROCESS, REFERENCES,
SELECT, SHOW DATABASES, SHOW VIEW, TRIGGER, UPDATE, USAGE,
RELOAD, LOCK TABLES, REPLICATION CLIENT, REPLICATION SLAVE
ON *.* to ${DATASOURCE_ADMIN_USER_NAME}@'%';`,
},
learnMoreLinks: [
{
titleKey: "instance.info.configure-database-user.link",
url: "https://docs.bytebase.com/get-started/instance?source=console#configure-a-database-user",
},
],
};
const mysqlContent: Partial<Record<InfoSection, InfoSnippet>> = {
host: {
contentKey: "instance.info.mysql.host.content",
learnMoreLinks: [
{
titleKey: "instance.info.connect-instance.link",
url: "https://docs.bytebase.com/get-started/instance?source=console",
},
],
},
authentication: mysqlAuthentication,
ssl: {
contentKey: "instance.info.mysql.ssl.content",
learnMoreLinks: [
{
titleKey: "instance.info.ssl-tls-connection.link",
url: "https://docs.bytebase.com/get-started/instance?source=console#ssltls-connection",
},
],
},
ssh: {
contentKey: "instance.info.mysql.ssh.content",
learnMoreLinks: [
{
titleKey: "instance.info.ssh-tunnel.link",
url: "https://docs.bytebase.com/get-started/instance?source=console#ssh-tunnel",
},
],
},
};
// TiDB, MariaDB, and OceanBase reuse the MySQL snippets, but the definer warning names
// MySQL versions, so only MySQL gets it.
const mysqlOnlyContent: Partial<Record<InfoSection, InfoSnippet>> = {
...mysqlContent,
authentication: {
...mysqlAuthentication,
warning: {
key: "instance.sentence.create-user-example.mysql.warn",
url: "https://docs.bytebase.com/get-started/connect/mysql?source=console#create-a-user-for-bytebase",
},
},
};
const mongodbContent: Partial<Record<InfoSection, InfoSnippet>> = {
host: {
contentKey: "instance.info.mongodb.host.content",
learnMoreLinks: [
{
titleKey: "instance.info.connect-instance.link",
url: "https://docs.bytebase.com/get-started/instance?source=console",
},
],
},
authentication: {
contentKey: "instance.info.mongodb.authentication.content",
contentInterpolation: {
user: DATASOURCE_ADMIN_USER_NAME,
},
codeBlock: {
language: "javascript",
code: `use admin;
db.createUser({
user: "${DATASOURCE_ADMIN_USER_NAME}",
pwd: "YOUR_DB_PWD",
roles: [
{role: "readWriteAnyDatabase", db: "admin"},
{role: "dbAdminAnyDatabase", db: "admin"},
{role: "userAdminAnyDatabase", db: "admin"}
]
});`,
},
learnMoreLinks: [
{
titleKey: "instance.info.configure-database-user.link",
url: "https://docs.bytebase.com/get-started/instance?source=console#configure-a-database-user",
},
],
},
ssl: {
contentKey: "instance.info.mongodb.ssl.content",
learnMoreLinks: [
{
titleKey: "instance.info.ssl-tls-connection.link",
url: "https://docs.bytebase.com/get-started/instance?source=console#ssltls-connection",
},
],
},
ssh: {
contentKey: "instance.info.mongodb.ssh.content",
learnMoreLinks: [
{
titleKey: "instance.info.ssh-tunnel.link",
url: "https://docs.bytebase.com/get-started/instance?source=console#ssh-tunnel",
},
],
},
};
const engineContentMap: Partial<
Record<Engine, Partial<Record<InfoSection, InfoSnippet>>>
> = {
[Engine.POSTGRES]: postgresqlContent,
[Engine.MYSQL]: mysqlOnlyContent,
[Engine.TIDB]: mysqlContent,
[Engine.MARIADB]: mysqlContent,
[Engine.OCEANBASE]: mysqlContent,
[Engine.MONGODB]: mongodbContent,
};
const sharedContent: Partial<Record<InfoSection, InfoSnippet>> = {
"sync-databases": {
contentKey: "instance.info.sync-databases.content",
},
};
export const getInfoContent = (
engine: Engine,
section: InfoSection
): InfoSnippet | undefined => {
return engineContentMap[engine]?.[section] ?? sharedContent[section];
};
export const hasInfoContent = (engine: Engine, section: InfoSection): boolean =>
!!getInfoContent(engine, section);