Skip to content

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

chore: multi-export in sql editor (#17966)

ecmadaodbb6f8b88705
diff --git a/frontend/src/views/sql-editor/EditorCommon/ResultView/ResultViewV1.vue b/frontend/src/views/sql-editor/EditorCommon/ResultView/ResultViewV1.vue
index ef97369cf0..bf6c6ad555 100644
--- a/frontend/src/views/sql-editor/EditorCommon/ResultView/ResultViewV1.vue
+++ b/frontend/src/views/sql-editor/EditorCommon/ResultView/ResultViewV1.vue
@@ -19,6 +19,8 @@
:database="database"
:result="resultSet.results[0]"
:set-index="0"
+ :show-export="!disableExport"
+ @export="handleExportBtnClick"
/>
</template>
<template v-else-if="viewMode === 'MULTI-RESULT'">
@@ -37,7 +39,7 @@
<template #tab>
<NTooltip>
<template #trigger>
- <div class="flex items-center gap-x-2">
+ <div class="flex items-center gap-x-2 mb-1">
<span>{{ tabName(i) }}</span>
<Info
v-if="result.error"
@@ -61,8 +63,39 @@
:database="database"
:result="result"
:set-index="i"
+ :show-export="!enableExportData"
+ @export="handleExportBtnClick"
/>
</NTabPane>
+ <template v-if="enableExportData" #suffix>
+ <div class="mb-1">
+ <DataExportButton
+ size="small"
+ :disabled="false"
+ :support-formats="[
+ ExportFormat.CSV,
+ ExportFormat.JSON,
+ ExportFormat.SQL,
+ ExportFormat.XLSX,
+ ]"
+ :view-mode="'DRAWER'"
+ :support-password="true"
+ @export="
+ ($event) =>
+ handleExportBtnClick({
+ ...$event,
+ statement: executeParams.statement,
+ })
+ "
+ >
+ <template #form>
+ <NFormItem :label="$t('common.database')">
+ <DatabaseInfo :database="database" />
+ </NFormItem>
+ </template>
+ </DataExportButton>
+ </div>
+ </template>
</NTabs>
</template>
<template v-else-if="viewMode === 'EMPTY'">
@@ -112,7 +145,9 @@
</template>
<script lang="ts" setup>
+import { create } from "@bufbuild/protobuf";
import { Code } from "@connectrpc/connect";
+import dayjs from "dayjs";
import { Info } from "lucide-vue-next";
import {
darkTheme,
@@ -120,22 +155,41 @@ import {
NTabPane,
NTabs,
NTooltip,
+ NFormItem,
} from "naive-ui";
import { computed, ref, toRef } from "vue";
import { useI18n } from "vue-i18n";
import { darkThemeOverrides } from "@/../naive-ui.config";
import { BBSpin } from "@/bbkit";
+import DataExportButton from "@/components/DataExportButton.vue";
+import type {
+ DownloadContent,
+ ExportOption,
+} from "@/components/DataExportButton.vue";
import SyncDatabaseButton from "@/components/DatabaseDetail/SyncDatabaseButton.vue";
+import DatabaseInfo from "@/components/DatabaseInfo.vue";
import { parseStringToResource } from "@/components/GrantRequestPanel/DatabaseResourceForm/common";
import { Drawer } from "@/components/v2";
-import { useConnectionOfCurrentSQLEditorTab, usePolicyV1Store } from "@/store";
+import {
+ useConnectionOfCurrentSQLEditorTab,
+ usePolicyV1Store,
+ useSQLEditorTabStore,
+ useSQLStore,
+ useSQLEditorStore,
+} from "@/store";
import type {
ComposedDatabase,
DatabaseResource,
SQLEditorQueryParams,
SQLResultSetV1,
} from "@/types";
-import { PolicyType } from "@/types/proto-es/v1/org_policy_service_pb";
+import { ExportFormat } from "@/types/proto-es/v1/common_pb";
+import {
+ PolicyType,
+ QueryDataPolicySchema,
+ type QueryDataPolicy,
+} from "@/types/proto-es/v1/org_policy_service_pb";
+import { ExportRequestSchema } from "@/types/proto-es/v1/sql_service_pb";
import { hasWorkspacePermissionV2 } from "@/utils";
import { provideBinaryFormatContext } from "./DataTable/binary-format-store";
import DetailPanel from "./DetailPanel";
@@ -173,6 +227,29 @@ const { t } = useI18n();
const policyStore = usePolicyV1Store();
const { instance, database: connectedDatabase } =
useConnectionOfCurrentSQLEditorTab();
+const tabStore = useSQLEditorTabStore();
+const editorStore = useSQLEditorStore();
+
+const getQueryDataPolicyByParent = (parent: string): QueryDataPolicy => {
+ const policy = policyStore.getPolicyByParentAndType({
+ parentPath: parent,
+ policyType: PolicyType.DATA_QUERY,
+ });
+ return policy?.policy?.case === "queryDataPolicy"
+ ? policy.policy.value
+ : create(QueryDataPolicySchema, {});
+};
+
+const disableExport = computed(
+ () => getQueryDataPolicyByParent("").disableExport
+);
+
+const enableExportData = computed(() => {
+ return (
+ !disableExport.value &&
+ props.resultSet?.results.every((result) => result.allowExport)
+ );
+});
const keyword = ref("");
const detail: SQLResultViewContext["detail"] = ref(undefined);
@@ -242,14 +319,7 @@ const disallowCopyingData = computed(() => {
let environment = instance.value.environment;
if (props.database) {
- const projectLevelPolicy = policyStore.getPolicyByParentAndType({
- parentPath: props.database?.project,
- policyType: PolicyType.DATA_QUERY,
- });
- if (
- projectLevelPolicy?.policy?.case === "queryDataPolicy" &&
- projectLevelPolicy.policy.value.disableCopyData
- ) {
+ if (getQueryDataPolicyByParent(props.database?.project).disableCopyData) {
return true;
}
// If the database is provided, use its effective environment.
@@ -258,14 +328,7 @@ const disallowCopyingData = computed(() => {
// Check if the environment has a policy that disables copying data.
if (environment) {
- const policy = policyStore.getPolicyByParentAndType({
- parentPath: environment,
- policyType: PolicyType.DATA_QUERY,
- });
- if (
- policy?.policy?.case === "queryDataPolicy" &&
- policy.policy.value.disableCopyData
- ) {
+ if (getQueryDataPolicyByParent(environment).disableCopyData) {
return true;
}
}
@@ -289,4 +352,44 @@ provideSQLResultViewContext({
keyword,
detail,
});
+
+const handleExportBtnClick = async ({
+ options,
+ resolve,
+ reject,
+ statement,
+}: {
+ statement: string;
+ options: ExportOption;
+ reject: (reason?: any) => void;
+ resolve: (content: DownloadContent[]) => void;
+}) => {
+ const admin = tabStore.currentTab?.mode === "ADMIN";
+ const limit = options.limit ?? (admin ? 0 : editorStore.resultRowsLimit);
+
+ try {
+ const content = await useSQLStore().exportData(
+ create(ExportRequestSchema, {
+ name: props.database.name,
+ dataSourceId: props.executeParams.connection.dataSourceId ?? "",
+ format: options.format,
+ statement,
+ limit,
+ admin,
+ password: options.password,
+ schema: props.executeParams.connection.schema,
+ })
+ );
+
+ resolve([
+ {
+ content,
+ // the download file is always zip file.
+ filename: `${props.database.databaseName}.${dayjs(new Date()).format("YYYY-MM-DDTHH-mm-ss")}.zip`,
+ },
+ ]);
+ } catch (e) {
+ reject(e);
+ }
+};
</script>
diff --git a/frontend/src/views/sql-editor/EditorCommon/ResultView/SingleResultViewV1.vue b/frontend/src/views/sql-editor/EditorCommon/ResultView/SingleResultViewV1.vue
index 75cf0477d4..5836ca592e 100644
--- a/frontend/src/views/sql-editor/EditorCommon/ResultView/SingleResultViewV1.vue
+++ b/frontend/src/views/sql-editor/EditorCommon/ResultView/SingleResultViewV1.vue
@@ -87,7 +87,7 @@
{{ $t("plugin.ai.text2sql") }}
</template>
</NTooltip>
- <template v-if="!disallowExportQueryData">
+ <template v-if="showExport">
<DataExportButton
v-if="result.allowExport"
size="small"
@@ -100,7 +100,13 @@
]"
:view-mode="'DRAWER'"
:support-password="true"
- @export="handleExportBtnClick"
+ @export="
+ ($event) =>
+ $emit('export', {
+ ...$event,
+ statement: result.statement,
+ })
+ "
>
<template #form>
<NFormItem :label="$t('common.database')">
@@ -186,7 +192,6 @@
</template>
<script lang="ts" setup>
-import { create } from "@bufbuild/protobuf";
import type { ColumnDef } from "@tanstack/vue-table";
import {
getCoreRowModel,
@@ -196,7 +201,6 @@ import {
} from "@tanstack/vue-table";
import { useClipboard } from "@vueuse/core";
import { useDebounceFn, useLocalStorage } from "@vueuse/core";
-import dayjs from "dayjs";
import { isEmpty } from "lodash-es";
import { ExternalLinkIcon } from "lucide-vue-next";
import {
@@ -225,10 +229,8 @@ import { DISMISS_PLACEHOLDER } from "@/plugins/ai/components/state";
import { PROJECT_V1_ROUTE_PLAN_DETAIL } from "@/router/dashboard/projectV1";
import {
useConnectionOfCurrentSQLEditorTab,
- usePolicyByParentAndType,
useSQLEditorStore,
useSQLEditorTabStore,
- useSQLStore,
useStorageStore,
pushNotification,
} from "@/store";
@@ -239,9 +241,7 @@ import {
isValidInstanceName,
} from "@/types";
import { Engine, ExportFormat } from "@/types/proto-es/v1/common_pb";
-import { PolicyType } from "@/types/proto-es/v1/org_policy_service_pb";
import {
- ExportRequestSchema,
type QueryResult,
type QueryRow,
type RowValue,
@@ -283,6 +283,19 @@ const props = defineProps<{
database: ComposedDatabase;
result: QueryResult;
setIndex: number;
+ showExport: boolean;
+}>();
+
+defineEmits<{
+ (
+ event: "export",
+ option: {
+ resolve: (content: DownloadContent[]) => void;
+ reject: (reason?: any) => void;
+ options: ExportOption;
+ statement: string;
+ }
+ ): Promise<void>;
}>();
const state = reactive<LocalState>({
@@ -315,19 +328,6 @@ const editorStore = useSQLEditorStore();
const currentTab = computed(() => tabStore.currentTab);
const { instance: connectedInstance } = useConnectionOfCurrentSQLEditorTab();
-const { policy: queryDataPolicy } = usePolicyByParentAndType(
- computed(() => ({
- parentPath: "",
- policyType: PolicyType.DATA_QUERY,
- }))
-);
-
-const disallowExportQueryData = computed(() => {
- return queryDataPolicy.value?.policy?.case === "queryDataPolicy"
- ? queryDataPolicy.value.policy.value.disableExport
- : false;
-});
-
const viewMode = computed((): ViewMode => {
const { result } = props;
if (result.error && dataLength.value === 0) {
@@ -486,44 +486,6 @@ const pageSizeOptions = computed(() => {
}));
});
-const handleExportBtnClick = async ({
- options,
- resolve,
- reject,
-}: {
- options: ExportOption;
- reject: (reason?: any) => void;
- resolve: (content: DownloadContent[]) => void;
-}) => {
- const admin = tabStore.currentTab?.mode === "ADMIN";
- const limit = options.limit ?? (admin ? 0 : editorStore.resultRowsLimit);
-
- try {
- const content = await useSQLStore().exportData(
- create(ExportRequestSchema, {
- name: props.database.name,
- dataSourceId: props.params.connection.dataSourceId ?? "",
- format: options.format,
- statement: props.result.statement,
- limit,
- admin,
- password: options.password,
- schema: props.params.connection.schema,
- })
- );
-
- resolve([
- {
- content,
- // the download file is always zip file.
- filename: `${props.database.databaseName}.${dayjs(new Date()).format("YYYY-MM-DDTHH-mm-ss")}.zip`,
- },
- ]);
- } catch (e) {
- reject(e);
- }
-};
-
const handleRequestExport = async () => {
if (!props.database) {
return;