Skip to content

Databricks DataSource #1763

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ node_modules

# Local Netlify folder
.netlify
.vscode/settings.json
1 change: 1 addition & 0 deletions client/packages/lowcoder-design/src/icons/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ export { ReactComponent as MongoIcon } from "./v1/icon-query-MongoDB.svg";
export { ReactComponent as PostgresIcon } from "./v1/icon-query-postgres.svg";
export { ReactComponent as RedisIcon } from "./v1/icon-query-Redis.svg";
export { ReactComponent as MSSQLIcon } from "./v1/icon-query-mssql.svg";
export { ReactComponent as DatabricksIcon } from "./v1/icon-query-databricks.svg";
export { ReactComponent as SMTPIcon } from "./v1/icon-query-SMTP.svg";
export { ReactComponent as OracleIcon } from "./v1/icon-query-OracleDB.svg";
export { ReactComponent as ClickHouseIcon } from "./v1/icon-query-ClickHouse.svg";
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions client/packages/lowcoder/src/api/datasourceApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ export interface SQLConfig extends PreparedStatementConfig {
usingSsl: boolean;
}

export interface DatabricksConfig extends SQLConfig {
authMechanism: string; // 3: Personal Access Token, 11: OAuth
usingUri: boolean;
jdbcUri: string;
httpPath: string;
catalog: string;
}
export interface MongoConfig extends SQLConfig {
uri: string;
usingUri: boolean;
Expand Down Expand Up @@ -123,6 +130,7 @@ export type DatasourceConfigType =
| SQLConfig
| HttpConfig
| MongoConfig
| DatabricksConfig
| OAuthBasicConfig
| EsConfig
| OracleConfig
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
import {
DataSourceTypeConfig,
FullColumnInfo,
generateInsertSql,
QueryDataType,
} from "./dataSourceCommon";
import {
CompSelection,
dateCompSelection,
allCompSelection,
numberCompSelection,
timeCompSelection,
dateTimeCompSelection,
} from "./comp";

function getCompSelection(columnType: string): CompSelection | undefined {
if (!columnType) {
return undefined;
}
switch (columnType.toLowerCase()) {
case "bit":
case "tinyint":
case "smallint":
case "int":
case "bigint":
case "dec":
case "decimal":
case "numeric":
case "smallmoney":
case "money":
case "float":
case "real":
return numberCompSelection(true);
case "date":
return dateCompSelection();
case "datetime":
case "smalldatetime":
return dateTimeCompSelection();
case "time":
return timeCompSelection();
}
return allCompSelection();
}

function getQueryInitData(
formName: string,
tableName: string,
infos: FullColumnInfo[]
): QueryDataType {
return {
compType: "databricks",
comp: {
sql: generateInsertSql(tableName, infos),
commandType: "INSERT",
mode: "SQL",
},
};
}

export const databricksConfig: DataSourceTypeConfig = {
type: "databricks",
getCompSelection,
getQueryInitData,
};
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { msSqlConfig } from "./mssql";
import { mysqlConfig } from "./mysql";
import { oracleSqlConfig } from "./oracle";
import { postgreSqlConfig } from "./postgresql";
import { databricksConfig } from "./databricks";
import { DatasourceType } from "@lowcoder-ee/constants/queryConstants";

export function getDataSourceTypeConfig(
Expand All @@ -14,6 +15,8 @@ export function getDataSourceTypeConfig(
return mysqlConfig;
case "postgres":
return postgreSqlConfig;
case "databricks":
return databricksConfig;
case "mssql":
return msSqlConfig;
case "oracle":
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ export const QueryGeneralPropertyView = (props: {

<br/>

{["postgres", "mysql", "mssql", "oracle", "mariadb"].includes(datasourceType) && (
{["databricks", "postgres", "mysql", "mssql", "oracle", "mariadb"].includes(datasourceType) && (
<SupaDemoDisplay
url={trans("supademos.dataquery2table")}
modalWidth="80%"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export const databasePlugins: Partial<DatasourceType>[] = [
"mysql",
"mongodb",
"postgres",
"databricks",
"redis",
"es",
"mssql",
Expand Down
2 changes: 2 additions & 0 deletions client/packages/lowcoder/src/constants/queryConstants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export type DatasourceType =
| "redis"
| "es"
| "mssql"
| "databricks"
| "smtp"
| "oracle"
| "clickHouse"
Expand All @@ -46,6 +47,7 @@ export const QueryMap = {
redis: RedisQuery,
es: EsQuery,
mssql: SQLQuery,
databricks: SQLQuery,
smtp: SMTPQuery,
oracle: SQLQuery,
clickHouse: SQLQuery,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
import React, { useState, useEffect } from "react";
import { DatasourceForm, FormInputItem, FormSection, FormSelectItem, FormInputPasswordItem, FormNumberInputItem, FormCheckboxItem } from "lowcoder-design";
import { DatabricksConfig } from "api/datasourceApi";
import { DatasourceFormProps } from "./datasourceFormRegistry";
import { useHostCheck } from "./useHostCheck";
import { trans } from "i18n";
import {
DatabaseFormInputItem,
DatasourceNameFormInputItem,
encryptedPlaceholder,
HostFormInputItem,
PasswordFormInputItem,
PortFormInputItem,
SSLFormCheckboxItem,
// UserNameFormInputItem, // removed
} from "../form";

export const DatabricksDatasourceForm = (props: DatasourceFormProps) => {
const { form, datasource, size } = props;
const datasourceConfig = datasource?.datasourceConfig as DatabricksConfig;
const [usingUri, setUsingUri] = useState(datasourceConfig?.usingUri);
const hostRule = useHostCheck();

// Set username to "token" if Auth Mechanism is PAT (3)
useEffect(() => {
if (!usingUri && form.getFieldValue("authMechanism") === "3") {
form.setFieldsValue({ username: "token" });
}
}, [usingUri, form.getFieldValue("authMechanism"), form]);

return (
<DatasourceForm form={form} preserve={false}>
<FormSection $size={size}>
<DatasourceNameFormInputItem
placeholder={"My DatabricksDB1"}
initialValue={datasource?.name}
/>
</FormSection>

<FormSection $size={size}>
<FormSelectItem
name={"usingUri"}
label={trans("query.connectionType")}
options={[
{ label: trans("query.regular"), value: "false" },
{ label: "JDBC URI", value: "true" },
]}
initialValue={datasourceConfig?.usingUri ? "true" : "false"}
afterChange={(value) => setUsingUri(value === "true")}
/>
</FormSection>

<FormSection $size={size}>
{usingUri ? (
<FormInputItem
name={"jdbcUri"}
label="JDBC URI"
required={true}
placeholder={encryptedPlaceholder}
rules={[
{
required: !datasourceConfig?.usingUri && true,
message: trans("query.uriRequiredMessage"),
},
{
pattern: new RegExp(
"^jdbc:databricks:\/\/([a-zA-Z0-9\.-]+):([0-9]{2,5});httpPath=(?:sql\/1\.0\/warehouses\/[a-zA-Z0-9]+|sql\/protocolv1\/o\/[0-9]+\/[0-9]{4}-[0-9]{6}-[a-zA-Z0-9]+);AuthMech=(?:[0-9]+)(?:;[a-zA-Z0-9_]+=[^;]+)*;$"
),
message: trans("query.uriErrorMessage"),
},
hostRule,
]}
/>
) : (
<>

<HostFormInputItem initialValue={datasourceConfig?.host} />
<PortFormInputItem initialValue={"443"} port={datasourceConfig?.port} />


<FormInputItem
name={"httpPath"}
label="Http Path"
required={true}
placeholder="/sql/1.0/warehouses/xxxxxxxxxxxxxxxx"
initialValue={datasourceConfig?.httpPath}
rules={[
{
required: true,
message: "Http Path is required",
},
]}
/>

<FormSelectItem
name={"authMechanism"}
label={"Auth Mechanism"}
options={[
{ label: "Personal Access Token", value: "3" }
]}
initialValue={"3"}
// Only one option, so no onChange needed
/>

<FormInputPasswordItem
name={"password"}
label="Access Token"
required={true}
placeholder={encryptedPlaceholder}
initialValue={datasourceConfig?.password}
rules={[
{
required: true,
message: "Personal Access Token is required",
},
]}
/>

<FormInputItem
name={"catalog"}
label="Catalog"
required={false}
placeholder="hive_metastore"
initialValue={datasourceConfig?.catalog}
rules={[]}
/>

<DatabaseFormInputItem
database={datasourceConfig?.database}
label="Schema"
/>

<SSLFormCheckboxItem usingSSl={datasourceConfig?.usingSsl} />
</>
)}
</FormSection>
</DatasourceForm>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { GoogleSheetsDatasourceForm } from "./googleSheetsDatasourceForm";
import { DatasourceType } from "@lowcoder-ee/constants/queryConstants";
import { Datasource } from "@lowcoder-ee/constants/datasourceConstants";
import { sqlDatasourceForm } from "./sqlDatasourceForm";
import { DatabricksDatasourceForm } from "./databricksDatasourceForm";
import { GraphqlDatasourceForm } from "./graphqlDatasourceForm";
import { OracleDatasourceForm } from "./oracleDatasourceForm";
import { DataSourceTypeInfo } from "api/datasourceApi";
Expand Down Expand Up @@ -55,4 +56,5 @@ export const DatasourceFormRegistry: Partial<Record<DatasourceType, DatasourceFo
form: sqlDatasourceForm({ placeholder: "My MariaDB1", port: "3306" }),
whitelist: true,
},
databricks: { form: DatabricksDatasourceForm, whitelist: true }
};
Original file line number Diff line number Diff line change
Expand Up @@ -239,6 +239,7 @@ const DataSourcesTab: React.FC<DataSourcesTabProps> = ({ environment, workspaceI
'elasticsearch': '#005571',
'oracle': '#F80000',
'mssql': '#CC2927',
'databricks': '#F55322',
'snowflake': '#29B5E8'
};

Expand Down
3 changes: 3 additions & 0 deletions client/packages/lowcoder/src/util/bottomResUtils.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
MariaDBIcon,
MongoIcon,
MSSQLIcon,
DatabricksIcon,
MysqlIcon,
OptionsApiIcon,
OracleIcon,
Expand Down Expand Up @@ -124,6 +125,8 @@ export const getBottomResIcon = (
return <EsIcon />;
case "mssql":
return <MSSQLIcon />;
case "databricks":
return <DatabricksIcon />;
case "smtp":
return <SMTPIcon />;
case "oracle":
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,14 @@ public class DatasourceMetaInfoServiceImpl implements DatasourceMetaInfoService
.connectionPool(ClientBasedConnectionPool.class)
.build();

private static final DatasourceMetaInfo DATABRICKS = DatasourceMetaInfo.builder()
.type("databricks")
.displayName("Databricks")
.pluginExecutorKey("databricks-plugin")
.hasStructureInfo(true)
.connectionPool(ClientBasedConnectionPool.class)
.build();

private static final DatasourceMetaInfo ORACLE = DatasourceMetaInfo.builder()
.type("oracle")
.displayName("Oracle")
Expand Down
Loading
Loading