diff --git a/.changeset/afraid-rules-yell.md b/.changeset/afraid-rules-yell.md index ab32da1cd9..258a07dc89 100644 --- a/.changeset/afraid-rules-yell.md +++ b/.changeset/afraid-rules-yell.md @@ -2,4 +2,4 @@ '@backstage/backend-common': patch --- -Updated the backend database connection configuration schema to include the full PG object details in order to set the password visibility to secret +Updated the backend database connection configuration schema to set the password visibility to secret diff --git a/packages/backend-common/config.d.ts b/packages/backend-common/config.d.ts index 42033a8c9f..512341ec3a 100644 --- a/packages/backend-common/config.d.ts +++ b/packages/backend-common/config.d.ts @@ -81,57 +81,17 @@ export interface Config { */ connection: | string - | { + | Partial<{ /** - * User with which to authenticate to the server - */ - user?: string; - /** - * Corresponding password + * Password that belongs to the Postgres User * @visibility secret */ password: string; /** - * Postgres server hostname or, for UNIX domain sockets, the socket filename + * Other Knex (PG) object settings */ - host?: string; - /** - * Database name within the server - */ - database?: string; - /** - * Port on which to connect - */ - port?: number; - /** - * TLS/SSL connections settings - */ - ssl?: boolean | ConnectionOptions; - /** - * Custom type parsers - */ - types?: CustomTypesConfig; - /** - * Number of milliseconds before a statement in query will time out, default is no timeout - */ - statement_timeout?: false | number; - /** - * Number of milliseconds before a query call will timeout, default is no timeout - */ - query_timeout?: number; - /** - * The name of the application that created this Client instance - */ - application_name?: string; - /** - * Number of milliseconds to wait for connection, default is no timeout - */ - connectionTimeoutMillis?: number; - /** - * Number of milliseconds before terminating any session with an open idle transaction, default is no timeout - */ - idle_in_transaction_session_timeout?: number; - }; + [key: string]: unknown; + }>; /** Database name prefix override */ prefix?: string; /**