Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Prg 160 add field grouping format and group host and port fields (#64280)

Jakub Chodorowicz390e559dc296
diff --git a/.loki/reference/chrome_laptop_App_Databases_DatabaseForm_Default.png b/.loki/reference/chrome_laptop_App_Databases_DatabaseForm_Default.png
new file mode 100644
index 00000000000..4180037e248
Binary files /dev/null and b/.loki/reference/chrome_laptop_App_Databases_DatabaseForm_Default.png differ
diff --git a/bin/build/src/build_drivers/lint_manifest_file.clj b/bin/build/src/build_drivers/lint_manifest_file.clj
index 36a5a074a69..6075b332f9b 100644
--- a/bin/build/src/build_drivers/lint_manifest_file.clj
+++ b/bin/build/src/build_drivers/lint_manifest_file.clj
@@ -47,7 +47,15 @@
:merge-map ::connection-property-map))
(s/def ::merge-map (spell/keys :req-un [::merge]))
+(s/def ::container-style-type #{"grid" "component"})
+(s/def ::container-style (s/cat :type ::container-style-type :value string?))
+(s/def ::fields (s/coll-of ::connection-property))
+(s/def ::group-map (spell/keys :req-un [::container-style ::fields]))
+(s/def ::group-property (spell/keys :req-un [::group]))
+(s/def ::group ::group-map)
+
(s/def ::connection-property (s/or :merge-with ::merge-map
+ :group-with ::group-property
:property-name ::raw-property-name-ref
:property-map (s/merge (spell/keys :req-un [::name]) ::connection-property-map)))
diff --git a/enterprise/frontend/src/embedding-sdk-package/cli/utils/ask-for-db-connection-info.ts b/enterprise/frontend/src/embedding-sdk-package/cli/utils/ask-for-db-connection-info.ts
index a1a6a71378d..beb30863dbf 100644
--- a/enterprise/frontend/src/embedding-sdk-package/cli/utils/ask-for-db-connection-info.ts
+++ b/enterprise/frontend/src/embedding-sdk-package/cli/utils/ask-for-db-connection-info.ts
@@ -6,7 +6,11 @@ import fileSelector from "inquirer-file-selector";
import toggle from "inquirer-toggle";
import { match } from "ts-pattern";
-import type { Engine, EngineField } from "metabase-types/api";
+import type {
+ DatabaseFieldOrGroup,
+ Engine,
+ EngineField,
+} from "metabase-types/api";
import { CLI_SHOWN_DB_FIELDS } from "../constants/database";
@@ -24,7 +28,7 @@ EventEmitter.defaultMaxListeners = 500;
export async function askForDatabaseConnectionInfo(options: Options) {
const { engine, engineKey } = options;
- const fields = engine["details-fields"] ?? [];
+ const fields = getFlattenedFields(engine["details-fields"] ?? []);
const connection: Record<string, string | boolean | number> = {};
@@ -154,3 +158,16 @@ const askSectionChoice = async (field: EngineField) => {
});
}
};
+
+export function getFlattenedFields(
+ fields: DatabaseFieldOrGroup[],
+): EngineField[] {
+ return fields.reduce<EngineField[]>((acc, field) => {
+ if (field.type === "group") {
+ acc.push(...field.fields);
+ } else {
+ acc.push(field);
+ }
+ return acc;
+ }, []);
+}
diff --git a/frontend/src/metabase-types/api/settings.ts b/frontend/src/metabase-types/api/settings.ts
index 21e27c69b57..bf328c27162 100644
--- a/frontend/src/metabase-types/api/settings.ts
+++ b/frontend/src/metabase-types/api/settings.ts
@@ -78,9 +78,29 @@ export type DatabaseProvider = {
export type EngineKey = (typeof engineKeys)[number];
+export type ContainerStyleType = "grid" | "component";
+export type ContainerStyle = [ContainerStyleType, string];
+
+export function isContainerStyle(value: unknown): value is ContainerStyle {
+ return (
+ Array.isArray(value) &&
+ value.length === 2 &&
+ (value[0] === "grid" || value[0] === "component") &&
+ typeof value[1] === "string"
+ );
+}
+
+export interface DatabaseFieldGroup {
+ type: "group";
+ "container-style": unknown;
+ fields: EngineField[];
+}
+
+export type DatabaseFieldOrGroup = EngineField | DatabaseFieldGroup;
+
export interface Engine {
"driver-name": string;
- "details-fields"?: EngineField[];
+ "details-fields"?: DatabaseFieldOrGroup[];
source: EngineSource;
"superseded-by": string | null;
"extra-info": {
diff --git a/frontend/src/metabase/databases/components/DatabaseForm/DatabaseForm.stories.tsx b/frontend/src/metabase/databases/components/DatabaseForm/DatabaseForm.stories.tsx
new file mode 100644
index 00000000000..c7bdff99836
--- /dev/null
+++ b/frontend/src/metabase/databases/components/DatabaseForm/DatabaseForm.stories.tsx
@@ -0,0 +1,31 @@
+import { ReduxProvider } from "__support__/storybook";
+import {
+ createMockSettingsState,
+ createMockState,
+} from "metabase-types/store/mocks";
+
+import { DatabaseForm } from "./DatabaseForm";
+import { TEST_ENGINES } from "./tests/setup";
+
+export default {
+ title: "App/Databases/DatabaseForm",
+ component: DatabaseForm,
+};
+
+const initialState = createMockState({
+ settings: createMockSettingsState({
+ engines: TEST_ENGINES,
+ }),
+});
+
+export const Default = () => (
+ <ReduxProvider storeInitialState={initialState}>
+ <DatabaseForm
+ initialValues={{
+ engine: "postgres",
+ }}
+ location="full-page"
+ config={{ isAdvanced: true }}
+ />
+ </ReduxProvider>
+);
diff --git a/frontend/src/metabase/databases/components/DatabaseForm/DatabaseFormBody.tsx b/frontend/src/metabase/databases/components/DatabaseForm/DatabaseFormBody.tsx
index 64a2841e7f3..1db4bd13885 100644
--- a/frontend/src/metabase/databases/components/DatabaseForm/DatabaseFormBody.tsx
+++ b/frontend/src/metabase/databases/components/DatabaseForm/DatabaseFormBody.tsx
@@ -1,22 +1,21 @@
import { useFormikContext } from "formik";
-import { type JSX, useMemo } from "react";
+import type { JSX } from "react";
import { match } from "ts-pattern";
import type {
DatabaseFormConfig,
FormLocation,
} from "metabase/databases/types";
-import { getVisibleFields } from "metabase/databases/utils/schema";
import { Box } from "metabase/ui";
import type { DatabaseData, Engine, EngineKey } from "metabase-types/api";
import { DatabaseConnectionStringField } from "../DatabaseConnectionUri";
-import { DatabaseDetailField } from "../DatabaseDetailField";
import { DatabaseEngineField } from "../DatabaseEngineField";
import DatabaseEngineWarning from "../DatabaseEngineWarning";
import { DatabaseFormError } from "../DatabaseFormError";
import { DatabaseNameField } from "../DatabaseNameField";
+import { DatabaseFormBodyDetails } from "./DatabaseFormBodyDetails";
import { useHasConnectionError } from "./utils";
interface DatabaseFormBodyProps {
@@ -44,13 +43,9 @@ export const DatabaseFormBody = ({
showSampleDatabase = false,
location,
}: DatabaseFormBodyProps): JSX.Element => {
- const { values, setValues } = useFormikContext<DatabaseData>();
+ const { setValues } = useFormikContext<DatabaseData>();
const hasConnectionError = useHasConnectionError();
- const fields = useMemo(() => {
- return engine ? getVisibleFields(engine, values, isAdvanced) : [];
- }, [engine, values, isAdvanced]);
-
const px = match(location)
.with("setup", () => "sm")
.with("embedding_setup", () => "xl")
@@ -90,16 +85,13 @@ export const DatabaseFormBody = ({
autoFocus={autofocusFieldName === "name"}
/>
)}
- {fields.map((field) => (
- <DatabaseDetailField
- key={field.name}
- field={field}
- autoFocus={autofocusFieldName === field.name}
- data-kek={field.name}
- engineKey={engineKey}
- engine={engine}
- />
- ))}
+ <DatabaseFormBodyDetails
+ fields={engine?.["details-fields"] ?? []}
+ autofocusFieldName={autofocusFieldName}
+ engineKey={engineKey}
+ engine={engine}
+ isAdvanced={isAdvanced}
+ />
{isAdvanced && hasConnectionError && <DatabaseFormError />}
</Box>
);
diff --git a/frontend/src/metabase/databases/components/DatabaseForm/DatabaseFormBodyDetails.tsx b/frontend/src/metabase/databases/components/DatabaseForm/DatabaseFormBodyDetails.tsx
new file mode 100644
index 00000000000..0685f5d23ff
--- /dev/null
+++ b/frontend/src/metabase/databases/components/DatabaseForm/DatabaseFormBodyDetails.tsx
@@ -0,0 +1,67 @@
+import { useFormikContext } from "formik";
+
+import type {
+ DatabaseData,
+ DatabaseFieldGroup,
+ DatabaseFieldOrGroup,
+ Engine,
+ EngineField,
+ EngineKey,
+} from "metabase-types/api";
+
+import { isDatabaseFieldGroup, shouldShowField } from "../../utils/schema";
+import { DatabaseDetailField } from "../DatabaseDetailField";
+
+import { CustomContainer } from "./container-styles";
+
+interface DatabaseFormBodyDetailsProps {
+ fields: DatabaseFieldOrGroup[];
+ autofocusFieldName?: string;
+ engineKey: EngineKey | undefined;
+ engine: Engine | undefined;
+ isAdvanced: boolean;
+}
+
+export function DatabaseFormBodyDetails({
+ fields,
+ autofocusFieldName,
+ engineKey,
+ engine,
+ isAdvanced,
+}: DatabaseFormBodyDetailsProps) {
+ const { values } = useFormikContext<DatabaseData>();
+
+ function renderField(engineField: EngineField) {
+ if (!shouldShowField(engineField, isAdvanced, values.details)) {
+ return null;
+ }
+
+ return (
+ <DatabaseDetailField
+ key={engineField.name}
+ field={engineField}
+ autoFocus={autofocusFieldName === engineField.name}
+ data-key={engineField.name}
+ engineKey={engineKey}
+ engine={engine}
+ />
+ );
+ }
+
+ function renderGroup(group: DatabaseFieldGroup) {
+ const key = group.fields.map((field) => field.name).join("-");
+ return (
+ <CustomContainer key={key} containerStyle={group["container-style"]}>
+ {group.fields.map(renderField)}
+ </CustomContainer>
+ );
+ }
+
+ return fields.map((field) => {
+ if (isDatabaseFieldGroup(field)) {
+ return renderGroup(field);
+ }
+
+ return renderField(field);
+ });
+}
diff --git a/frontend/src/metabase/databases/components/DatabaseForm/container-styles.tsx b/frontend/src/metabase/databases/components/DatabaseForm/container-styles.tsx
new file mode 100644
index 00000000000..d07e2578799
--- /dev/null
+++ b/frontend/src/metabase/databases/components/DatabaseForm/container-styles.tsx
@@ -0,0 +1,57 @@
+import { Box } from "metabase/ui";
+import { isContainerStyle } from "metabase-types/api";
+
+export function CustomContainer({
+ children,
+ containerStyle,
+}: {
+ children: React.ReactNode;
+ containerStyle: unknown;
+}) {
+ if (!isContainerStyle(containerStyle)) {
+ return <Box>{children}</Box>;
+ }
+ const [type, value] = containerStyle;
+
+ if (type === "grid") {
+ return (
+ <GridContainer gridTemplateColumns={value}>{children}</GridContainer>
+ );
+ }
+
+ if (type === "component") {
+ if (value === "backdrop") {
+ return <Backdrop>{children}</Backdrop>;
+ }
+ }
+
+ return <Box>{children}</Box>;
+}
+
+function GridContainer({
+ children,
+ gridTemplateColumns,
+}: {
+ children: React.ReactNode;
+ gridTemplateColumns: string;
+}) {
+ return (
+ <Box
+ style={{
+ display: "grid",
+ gridTemplateColumns,
+ gap: "1rem",
+ }}
+ >
+ {children}
+ </Box>
+ );
+}
+
+function Backdrop({ children }: { children: React.ReactNode }) {
+ return (
+ <Box p="lg" bg="background-light" bdrs="md" mb="lg" display="grid" pb={0}>
+ {children}
+ </Box>
+ );
+}
diff --git a/frontend/src/metabase/databases/components/DatabaseForm/tests/common.unit.spec.tsx b/frontend/src/metabase/databases/components/DatabaseForm/tests/common.unit.spec.tsx
index bee7d8d81a6..72a79e84f91 100644
--- a/frontend/src/metabase/databases/components/DatabaseForm/tests/common.unit.spec.tsx
+++ b/frontend/src/metabase/databases/components/DatabaseForm/tests/common.unit.spec.tsx
@@ -61,7 +61,10 @@ describe("DatabaseForm", () => {
...TEST_ENGINES.h2,
"details-fields":
TEST_ENGINES.h2["details-fields"]?.map((field) => {
- if (field.name === "is-destination-database") {
+ if (
+ field.type !== "group" &&
+ field.name === "is-destination-database"
+ ) {
return {
name: "is-destination-database",
type: "hidden",
@@ -69,7 +72,10 @@ describe("DatabaseForm", () => {
};
}
- if (field.name === "let-user-control-scheduling") {
+ if (
+ field.type !== "group" &&
+ field.name === "let-user-control-scheduling"
+ ) {
return {
name: "let-user-control-scheduling",
type: "boolean",
diff --git a/frontend/src/metabase/databases/components/DatabaseForm/tests/postgres-form-config.mock.ts b/frontend/src/metabase/databases/components/DatabaseForm/tests/postgres-form-config.mock.ts
index 3505ba09bba..2b62d0a8498 100644
--- a/frontend/src/metabase/databases/components/DatabaseForm/tests/postgres-form-config.mock.ts
+++ b/frontend/src/metabase/databases/components/DatabaseForm/tests/postgres-form-config.mock.ts
@@ -9,17 +9,23 @@ export const postgresFormConfig = {
},
"details-fields": [
{
- name: "host",
- "display-name": "Host",
- "helper-text":
- "Your database's IP address (e.g. 98.137.149.56) or its domain name (e.g. esc.mydatabase.com).",
- placeholder: "name.database.com",
- },
- {
- name: "port",
- "display-name": "Port",
- type: "integer",
- placeholder: 5432,
+ type: "group",
+ "container-style": ["grid", "3fr 1fr"],
+ fields: [
+ {
+ name: "host",
+ "display-name": "Host",
+ "helper-text":
+ "Your database's IP address (e.g. 98.137.149.56) or its domain name (e.g. esc.mydatabase.com).",
+ placeholder: "name.database.com",
+ },
+ {
+ name: "port",
+ "display-name": "Port",
+ type: "integer",
+ placeholder: 5432,
+ },
+ ],
},
{
name: "dbname",
diff --git a/frontend/src/metabase/databases/utils/schema.ts b/frontend/src/metabase/databases/utils/schema.ts
index aa196c2f91a..d5abfeea58e 100644
--- a/frontend/src/metabase/databases/utils/schema.ts
+++ b/frontend/src/metabase/databases/utils/schema.ts
@@ -2,7 +2,13 @@ import type { TestContext } from "yup";
import * as Yup from "yup";
import * as Errors from "metabase/lib/errors";
-import type { DatabaseData, Engine, EngineField } from "metabase-types/api";
+import type {
+ DatabaseData,
+ DatabaseFieldGroup,
+ DatabaseFieldOrGroup,
+ Engine,
+ EngineField,
+} from "metabase-types/api";
import { ADVANCED_FIELDS, FIELD_OVERRIDES } from "../constants";
@@ -19,7 +25,9 @@ export const getValidationSchema = (
engineKey: string | undefined,
isAdvanced: boolean,
) => {
- const fields = getDefinedFields(engine, isAdvanced).filter(isDetailField);
+ const flattenedFields = getFlattenedFields(engine?.["details-fields"] ?? []);
+ const definedFields = filterFieldsInAdvancedMode(flattenedFields, isAdvanced);
+ const fields = definedFields.filter(isDetailField);
const entries = fields.map((field) => [field.name, getFieldSchema(field)]);
return Yup.object({
@@ -42,36 +50,59 @@ export const getValidationSchema = (
});
};
-export const getVisibleFields = (
+export const getFieldsToShow = (
engine: Engine | undefined,
values: DatabaseData,
isAdvanced: boolean,
) => {
- const fields = getDefinedFields(engine, isAdvanced);
- return fields.filter((field) => isFieldVisible(field, values.details));
+ const fields = getFlattenedFields(engine?.["details-fields"] ?? []);
+ const filteredByAdvancedMode = filterFieldsInAdvancedMode(fields, isAdvanced);
+ return filteredByAdvancedMode.filter((field) => {
+ return isFieldVisible(field, values.details);
+ });
};
-export const getDefinedFields = (
- engine: Engine | undefined,
+export const filterFieldsInAdvancedMode = (
+ fields: EngineField[],
isAdvanced: boolean,
) => {
- const fields = engine?.["details-fields"] ?? [];
-
- return isAdvanced
- ? fields
- : fields.filter((field) => !ADVANCED_FIELDS.includes(field.name));
+ return fields.filter((field) =>
+ shouldShowFieldInAdvancedMode(field, isAdvanced),
+ );
};
+function shouldShowFieldInAdvancedMode(
+ field: EngineField,
+ isAdvanced: boolean,
+) {
+ return isAdvanced || !ADVANCED_FIELDS.includes(field.name);
+}
+
+export function getFlattenedFields(
+ fields: DatabaseFieldOrGroup[],
+): EngineField[] {
+ return fields.reduce<EngineField[]>((acc, field) => {
+ if (isDatabaseFieldGroup(field)) {
+ acc.push(...field.fields);
+ } else {
+ acc.push(field);
+ }
+ return acc;
+ }, []);
+}
+
export const getSubmitValues = (
engine: Engine | undefined,
values: DatabaseData,
isAdvanced: boolean,
): DatabaseData => {
- const fields = getVisibleFields(engine, values, isAdvanced);
- const entries = fields
- .filter((field) => isDetailField(field))
- .filter((field) => isFieldVisible(field, values.details))
- .map((field) => [field.name, values.details?.[field.name]]);
+ const fields = getFieldsToShow(engine, values, isAdvanced).filter(
+ isDetailField,
+ );
+ const entries = fields.map((field) => [
+ field.name,
+ values.details?.[field.name],
+ ]);
// "connection-string" is a FE only field. It's used to prefill the database form and we're not sending it to or storing it in the BE.
const submitValues = Object.entries(values).filter(
@@ -144,6 +175,17 @@ const isFieldVisible = (
);
};
+export function shouldShowField(
+ field: EngineField,
+ isAdvanced: boolean,
+ details?: Record<string, unknown>,
+) {
+ return (
+ isFieldVisible(field, details) &&
+ shouldShowFieldInAdvancedMode(field, isAdvanced)
+ );
+}
+
export function setDatabaseFormValues(
previousValues: DatabaseData,
newValues: DatabaseData,
@@ -157,3 +199,14 @@ export function setDatabaseFormValues(
},
};
}
+
+export function isDatabaseFieldGroup(
+ field: DatabaseFieldOrGroup,
+): field is DatabaseFieldGroup {
+ return (
+ typeof field === "object" &&
+ field !== null &&
+ "type" in field &&
+ field.type === "group"
+ );
+}
diff --git a/modules/drivers/clickhouse/resources/metabase-plugin.yaml b/modules/drivers/clickhouse/resources/metabase-plugin.yaml
index 593e3b84f1e..bfcd579124b 100644
--- a/modules/drivers/clickhouse/resources/metabase-plugin.yaml
+++ b/modules/drivers/clickhouse/resources/metabase-plugin.yaml
@@ -8,10 +8,13 @@ driver:
lazy-load: true
parent: sql-jdbc
connection-properties:
- - host
- - merge:
- - port
- - default: 8123
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - host
+ - merge:
+ - port
+ - default: 8123
- user
- password
- name: enable-multiple-db
diff --git a/modules/drivers/druid-jdbc/resources/metabase-plugin.yaml b/modules/drivers/druid-jdbc/resources/metabase-plugin.yaml
index 6dfb300a89c..ce91d5c762d 100644
--- a/modules/drivers/druid-jdbc/resources/metabase-plugin.yaml
+++ b/modules/drivers/druid-jdbc/resources/metabase-plugin.yaml
@@ -8,14 +8,17 @@ driver:
lazy-load: true
parent: sql-jdbc
connection-properties:
- - merge:
- - host
- - placeholder: http://localhost
- required: true
- - merge:
- - port
- - display-name: Router node port
- placeholder: 8888
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - merge:
+ - host
+ - placeholder: http://localhost
+ required: true
+ - merge:
+ - port
+ - display-name: Router node port
+ placeholder: 8888
- ssh-tunnel
- advanced-options-start
- name: json-unfolding
diff --git a/modules/drivers/druid/resources/metabase-plugin.yaml b/modules/drivers/druid/resources/metabase-plugin.yaml
index f1c7d6fdcf6..cb28acb4204 100644
--- a/modules/drivers/druid/resources/metabase-plugin.yaml
+++ b/modules/drivers/druid/resources/metabase-plugin.yaml
@@ -7,15 +7,18 @@ driver:
display-name: Druid
lazy-load: true
connection-properties:
- - merge:
- - host
- - placeholder: http://localhost
- required: true
- - merge:
- - port
- - display-name: Broker node port
- placeholder: 8082
- required: true
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - merge:
+ - host
+ - placeholder: http://localhost
+ required: true
+ - merge:
+ - port
+ - display-name: Broker node port
+ placeholder: 8082
+ required: true
- cloud-ip-address-info
- ssh-tunnel
- advanced-options-start
@@ -37,7 +40,6 @@ driver:
visible-if:
auth-enabled: true
- default-advanced-options
-
init:
- step: load-namespace
namespace: metabase.driver.druid
diff --git a/modules/drivers/mongo/resources/metabase-plugin.yaml b/modules/drivers/mongo/resources/metabase-plugin.yaml
index a9240128427..88268c44c51 100644
--- a/modules/drivers/mongo/resources/metabase-plugin.yaml
+++ b/modules/drivers/mongo/resources/metabase-plugin.yaml
@@ -17,20 +17,23 @@ driver:
required: true
visible-if:
use-conn-uri: true
- - merge:
- - host
- - visible-if:
- use-conn-uri: false
- required: true
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - merge:
+ - host
+ - visible-if:
+ use-conn-uri: false
+ required: true
+ - merge:
+ - port
+ - placeholder: 27017
+ visible-if:
+ use-conn-uri: false
- merge:
- dbname
- visible-if:
use-conn-uri: false
- - merge:
- - port
- - placeholder: 27017
- visible-if:
- use-conn-uri: false
- merge:
- user
- required: false
diff --git a/modules/drivers/oracle/resources/metabase-plugin.yaml b/modules/drivers/oracle/resources/metabase-plugin.yaml
index 12fbc4fa394..7efade02bf3 100644
--- a/modules/drivers/oracle/resources/metabase-plugin.yaml
+++ b/modules/drivers/oracle/resources/metabase-plugin.yaml
@@ -14,10 +14,13 @@ driver:
lazy-load: true
parent: sql-jdbc
connection-properties:
- - host
- - merge:
- - port
- - placeholder: 1521
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - host
+ - merge:
+ - port
+ - placeholder: 1521
- name: sid
display-name: Oracle system ID (SID)
placeholder: Usually something like ORCL or XE. Optional if using service name
diff --git a/modules/drivers/presto-jdbc/resources/metabase-plugin.yaml b/modules/drivers/presto-jdbc/resources/metabase-plugin.yaml
index c2124084b41..5b495b9bbbb 100644
--- a/modules/drivers/presto-jdbc/resources/metabase-plugin.yaml
+++ b/modules/drivers/presto-jdbc/resources/metabase-plugin.yaml
@@ -8,12 +8,15 @@ driver:
lazy-load: true
parent: sql-jdbc
connection-properties:
- - merge:
- - host
- - required: true
- - merge:
- - port
- - placeholder: 8080
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - merge:
+ - host
+ - required: true
+ - merge:
+ - port
+ - placeholder: 8080
- merge:
- dbname
- name: catalog
diff --git a/modules/drivers/redshift/resources/metabase-plugin.yaml b/modules/drivers/redshift/resources/metabase-plugin.yaml
index 9dee8a82281..f68af74a150 100644
--- a/modules/drivers/redshift/resources/metabase-plugin.yaml
+++ b/modules/drivers/redshift/resources/metabase-plugin.yaml
@@ -8,13 +8,16 @@ driver:
lazy-load: true
parent: postgres
connection-properties:
- - merge:
- - host
- - placeholder: my-cluster-name.abcd1234.us-east-1.redshift.amazonaws.com
- required: true
- - merge:
- - port
- - placeholder: 5439
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - merge:
+ - host
+ - placeholder: my-cluster-name.abcd1234.us-east-1.redshift.amazonaws.com
+ required: true
+ - merge:
+ - port
+ - placeholder: 5439
- merge:
- dbname
- name: db
diff --git a/modules/drivers/sparksql/resources/metabase-plugin.yaml b/modules/drivers/sparksql/resources/metabase-plugin.yaml
index 936f71c1930..233dd3d36a4 100644
--- a/modules/drivers/sparksql/resources/metabase-plugin.yaml
+++ b/modules/drivers/sparksql/resources/metabase-plugin.yaml
@@ -10,12 +10,15 @@ driver:
lazy-load: true
parent: hive-like
connection-properties:
- - merge:
- - host
- - required: true
- - merge:
- - port
- - placeholder: 10000
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - merge:
+ - host
+ - required: true
+ - merge:
+ - port
+ - placeholder: 10000
- merge:
- dbname
- placeholder: default
diff --git a/modules/drivers/sqlserver/resources/metabase-plugin.yaml b/modules/drivers/sqlserver/resources/metabase-plugin.yaml
index ff506384628..24bce0fd902 100644
--- a/modules/drivers/sqlserver/resources/metabase-plugin.yaml
+++ b/modules/drivers/sqlserver/resources/metabase-plugin.yaml
@@ -8,10 +8,13 @@ driver:
lazy-load: true
parent: sql-jdbc
connection-properties:
- - host
- - merge:
- - port
- - helper-text: Leave empty to use Dynamic Ports, or input specific port. Standard port is 1433.
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - host
+ - merge:
+ - port
+ - helper-text: Leave empty to use Dynamic Ports, or input specific port. Standard port is 1433.
- merge:
- dbname
- name: db
diff --git a/modules/drivers/starburst/resources/metabase-plugin.yaml b/modules/drivers/starburst/resources/metabase-plugin.yaml
index 0a7dc9748fc..5d98f590e06 100644
--- a/modules/drivers/starburst/resources/metabase-plugin.yaml
+++ b/modules/drivers/starburst/resources/metabase-plugin.yaml
@@ -8,10 +8,13 @@ driver:
lazy-load: true
parent: sql-jdbc
connection-properties:
- - host
- - merge:
- - port
- - default: 8080
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - host
+ - merge:
+ - port
+ - default: 8080
- merge:
- dbname
- name: catalog
@@ -46,7 +49,6 @@ driver:
- additional-options
- placeholder: "trustServerCertificate=false"
- default-advanced-options
-
init:
- step: load-namespace
namespace: metabase.driver.starburst
diff --git a/modules/drivers/vertica/resources/metabase-plugin.yaml b/modules/drivers/vertica/resources/metabase-plugin.yaml
index dbeccd9aa8f..abc99d2884b 100644
--- a/modules/drivers/vertica/resources/metabase-plugin.yaml
+++ b/modules/drivers/vertica/resources/metabase-plugin.yaml
@@ -14,10 +14,13 @@ driver:
lazy-load: true
parent: sql-jdbc
connection-properties:
- - host
- - merge:
- - port
- - placeholder: 5433
+ - group:
+ container-style: ["grid", "3fr 1fr"]
+ fields:
+ - host
+ - merge:
+ - port
+ - placeholder: 5433
- dbname
- user
- password
diff --git a/src/metabase/driver/mysql.clj b/src/metabase/driver/mysql.clj
index 199154d00be..1ee3f1fe8ba 100644
--- a/src/metabase/driver/mysql.clj
+++ b/src/metabase/driver/mysql.clj
@@ -230,8 +230,10 @@
(defmethod driver/connection-properties :mysql
[_]
(->>
- [driver.common/default-host-details
- (assoc driver.common/default-port-details :placeholder 3306)
+ [{:type :group
+ :container-style ["grid" "3fr 1fr"]
+ :fields [driver.common/default-host-details
+ (assoc driver.common/default-port-details :placeholder 3306)]}
driver.common/default-dbname-details
driver.common/default-user-details
(driver.common/auth-provider-options #{:aws-iam})
@@ -1195,3 +1197,7 @@
tiny-int-1-is-bit?)
"BIT"
db-type-name)))
+
+(defmethod driver/extra-info :mysql
+ [_driver]
+ nil)
diff --git a/src/metabase/driver/postgres.clj b/src/metabase/driver/postgres.clj
index c6affc6f288..4e902199356 100644
--- a/src/metabase/driver/postgres.clj
+++ b/src/metabase/driver/postgres.clj
@@ -157,8 +157,10 @@
(defmethod driver/connection-properties :postgres
[_]
(->>
- [driver.common/default-host-details
- (assoc driver.common/default-port-details :placeholder 5432)
+ [{:type :group
+ :container-style ["grid" "3fr 1fr"]
+ :fields [driver.common/default-host-details
+ (assoc driver.common/default-port-details :placeholder 5432)]}
driver.common/default-dbname-details
driver.common/default-user-details
(driver.common/auth-provider-options)
@@ -1286,7 +1288,9 @@
{:name "Render" :pattern "\\.render\\.com$"}
{:name "Scaleway" :pattern "\\.scw\\.cloud$"}
{:name "Supabase" :pattern "(pooler\\.supabase\\.com|\\.supabase\\.co)$"}
- {:name "Timescale" :pattern "(\\.tsdb\\.cloud|\\.timescale\\.com)$"}]})
+ {:name "Timescale" :pattern "(\\.tsdb\\.cloud|\\.timescale\\.com)$"}]
+ :field-groups [{:id "host-and-port"
+ :container-style "host-and-port-section"}]})
;; Custom nippy handling for PGobject to enable proper caching of postgres domains in arrays (#55301)
diff --git a/src/metabase/plugins/lazy_loaded_driver.clj b/src/metabase/plugins/lazy_loaded_driver.clj
index e1b4e9a6655..d9206f4b4d9 100644
--- a/src/metabase/plugins/lazy_loaded_driver.clj
+++ b/src/metabase/plugins/lazy_loaded_driver.clj
@@ -30,6 +30,12 @@
(not (map? prop))
(throw (Exception. (trs "Invalid connection property {0}: not a string or map." prop)))
+ (:group prop)
+ ;; Handle nested group structure
+ {:type :group
+ :container-style (:container-style (:group prop))
+ :fields (into [] (mapcat #(u/one-or-many (parse-connection-property %))) (:fields (:group prop)))}
+
(:merge prop)
(into {} (map parse-connection-property) (:merge prop))
@@ -38,10 +44,18 @@
(defn- parse-connection-properties
"Parse the connection properties included in the plugin manifest. These can be one of several things -- a key
- referring to one of the default maps in `driver.common`, a entire custom map, or a list of maps to `merge:` (e.g.
- for overriding part, but not all, of a default option)."
+ referring to one of the default maps in `driver.common`, a entire custom map, a list of maps to `merge:` (e.g.
+ for overriding part, but not all, of a default option), or a nested group structure."
[{:keys [connection-properties]}]
- (into [] (mapcat #(u/one-or-many (parse-connection-property %))) connection-properties))
+ (into []
+ (mapcat (fn [prop]
+ (let [parsed (parse-connection-property prop)]
+ ;; If parsed result is a group, keep it as a single item
+ ;; Otherwise apply one-or-many to flatten merged properties
+ (if (and (map? parsed) (= :group (:type parsed)))
+ [parsed]
+ (u/one-or-many parsed)))))
+ connection-properties))
(defn- make-initialize! [driver add-to-classpath! init-steps]
(fn [_]
diff --git a/test/metabase/driver_test.clj b/test/metabase/driver_test.clj
index e0e8ca1059d..7f1f7acc123 100644
--- a/test/metabase/driver_test.clj
+++ b/test/metabase/driver_test.clj
@@ -48,6 +48,19 @@
(is (driver/available? "metabase.driver-test/test-driver")
"`driver/available?` should work for if `driver` is a string -- see #10135")))
+(defn- flatten-connection-properties
+ "Recursively flatten connection properties, extracting all properties from groups.
+ Groups have :type :group and contain a :fields array with nested properties."
+ [props]
+ (mapcat (fn [prop]
+ (if (and (= (:type prop) :group)
+ (seq (:fields prop)))
+ ;; If it's a group, recursively flatten its fields
+ (flatten-connection-properties (:fields prop))
+ ;; Otherwise, return the property as-is
+ [prop]))
+ props))
+
(deftest ^:parallel unique-connection-property-test
;; abnormal usage here; we are not using the regular mt/test-driver or mt/test-drivers, because those involve
;; initializing the driver and test data namespaces, which don't necessarily exist for all drivers (ex:
@@ -58,8 +71,9 @@
(doseq [d (tx.env/test-drivers)]
(testing (str d " has entirely unique connection property names")
(let [props (driver/connection-properties d)
- props-by-name (group-by :name props)]
- (is (= (count props) (count props-by-name))
+ flattened-props (flatten-connection-properties props)
+ props-by-name (group-by :name flattened-props)]
+ (is (= (count flattened-props) (count props-by-name))
(format "Property(s) with duplicate name: %s" (-> (filter (fn [[_ props]]
(> (count props) 1))
props-by-name)
diff --git a/test/metabase/system/settings_test.clj b/test/metabase/system/settings_test.clj
index 722b2f7b98c..024610ef7ed 100644
--- a/test/metabase/system/settings_test.clj
+++ b/test/metabase/system/settings_test.clj
@@ -78,7 +78,7 @@
(mt/with-user-locale "zz"
(is (= "HOST"
(str (get-in (setting/user-readable-values-map #{:public})
- [:engines :postgres :details-fields 0 :display-name])))))))
+ [:engines :postgres :details-fields 0 :fields 0 :display-name])))))))
(deftest tru-translates
(mt/with-mock-i18n-bundles! {"zz" {:messages {"Host" "HOST"}}}