Skip to content

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

feat: support data query policy at project level (#18135)

ecmadao8a4a322cf76d
diff --git a/backend/api/v1/org_policy_service.go b/backend/api/v1/org_policy_service.go
index 80b224da98..5b983e8415 100644
--- a/backend/api/v1/org_policy_service.go
+++ b/backend/api/v1/org_policy_service.go
@@ -75,9 +75,9 @@ func (s *OrgPolicyService) GetPolicy(ctx context.Context, req *connect.Request[v
// ListPolicies lists policies in a specific resource.
func (s *OrgPolicyService) ListPolicies(ctx context.Context, req *connect.Request[v1pb.ListPoliciesRequest]) (*connect.Response[v1pb.ListPoliciesResponse], error) {
- resourceType, resource, err := getPolicyResourceTypeAndResource(req.Msg.Parent)
+ resourceType, resource, err := common.GetPolicyResourceTypeAndResource(req.Msg.Parent)
if err != nil {
- return nil, err
+ return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
find := &store.FindPolicyMessage{
@@ -260,9 +260,9 @@ func extractPolicyTypeFromName(policyName string) (storepb.Policy_Type, error) {
// getDefaultRolloutPolicy returns the default rollout policy when no custom policy exists.
// Uses the shared store.GetDefaultRolloutPolicy to ensure consistency across API and store layers.
func (*OrgPolicyService) getDefaultRolloutPolicy(_ context.Context, parent string, policyName string) (*v1pb.Policy, error) {
- resourceType, _, err := getPolicyResourceTypeAndResource(parent)
+ resourceType, _, err := common.GetPolicyResourceTypeAndResource(parent)
if err != nil {
- return nil, err
+ return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
v1ResourceType := v1pb.PolicyResourceType_RESOURCE_TYPE_UNSPECIFIED
@@ -303,9 +303,9 @@ func (s *OrgPolicyService) findPolicyMessage(ctx context.Context, policyName str
if strings.HasSuffix(policyParent, "/") {
policyParent = policyParent[:(len(policyParent) - 1)]
}
- resourceType, resource, err := getPolicyResourceTypeAndResource(policyParent)
+ resourceType, resource, err := common.GetPolicyResourceTypeAndResource(policyParent)
if err != nil {
- return nil, policyParent, err
+ return nil, policyParent, connect.NewError(connect.CodeInvalidArgument, err)
}
if resource == nil && resourceType != storepb.Policy_WORKSPACE {
return nil, policyParent, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("resource for %s must be specific", resourceType))
@@ -337,41 +337,10 @@ func (s *OrgPolicyService) findPolicyMessage(ctx context.Context, policyName str
return policy, policyParent, nil
}
-func getPolicyResourceTypeAndResource(requestName string) (storepb.Policy_Resource, *string, error) {
- if requestName == "" {
- return storepb.Policy_WORKSPACE, nil, nil
- }
-
- if strings.HasPrefix(requestName, common.ProjectNamePrefix) {
- projectID, err := common.GetProjectID(requestName)
- if err != nil {
- return storepb.Policy_RESOURCE_UNSPECIFIED, nil, connect.NewError(connect.CodeInvalidArgument, err)
- }
- if projectID == "-" {
- return storepb.Policy_PROJECT, nil, nil
- }
- return storepb.Policy_PROJECT, &requestName, nil
- }
-
- if strings.HasPrefix(requestName, common.EnvironmentNamePrefix) {
- // environment policy request name should be environments/{environment id}
- environmentID, err := common.GetEnvironmentID(requestName)
- if err != nil {
- return storepb.Policy_RESOURCE_UNSPECIFIED, nil, connect.NewError(connect.CodeInvalidArgument, err)
- }
- if environmentID == "-" {
- return storepb.Policy_ENVIRONMENT, nil, nil
- }
- return storepb.Policy_ENVIRONMENT, &requestName, nil
- }
-
- return storepb.Policy_RESOURCE_UNSPECIFIED, nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("unknown request name %s", requestName))
-}
-
func (s *OrgPolicyService) createPolicyMessage(ctx context.Context, parent string, policy *v1pb.Policy) (*v1pb.Policy, error) {
- resourceType, _, err := getPolicyResourceTypeAndResource(parent)
+ resourceType, _, err := common.GetPolicyResourceTypeAndResource(parent)
if err != nil {
- return nil, err
+ return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
policyType, err := convertV1PBToStorePBPolicyType(policy.Type)
diff --git a/backend/api/v1/sql_service.go b/backend/api/v1/sql_service.go
index 7053048ff0..aa055c4141 100644
--- a/backend/api/v1/sql_service.go
+++ b/backend/api/v1/sql_service.go
@@ -7,6 +7,7 @@ import (
"encoding/json"
"fmt"
"io"
+ "math"
"regexp"
"strings"
"time"
@@ -120,16 +121,33 @@ func (s *SQLService) AdminExecute(ctx context.Context, stream *connect.BidiStrea
}
}
- queryRestriction := getMaximumSQLResultLimit(ctx, s.store, s.licenseService, 0)
+ queryRestriction := getEffectiveQueryDataPolicy(
+ ctx,
+ s.store,
+ s.licenseService,
+ request.Limit,
+ database.ProjectID,
+ )
queryContext := db.QueryContext{
OperatorEmail: user.Email,
Container: request.GetContainer(),
MaximumSQLResultSize: queryRestriction.MaximumResultSize,
+ Limit: int(queryRestriction.MaximumResultRows),
}
if request.Schema != nil {
queryContext.Schema = *request.Schema
}
- result, duration, queryErr := executeWithTimeout(ctx, s.store, s.licenseService, driver, conn, request.Statement, queryContext)
+ if queryRestriction.MaxQueryTimeoutInSeconds > 0 {
+ queryContext.Timeout = &durationpb.Duration{Seconds: queryRestriction.MaxQueryTimeoutInSeconds}
+ }
+
+ result, duration, queryErr := executeWithTimeout(
+ ctx,
+ driver,
+ conn,
+ request.Statement,
+ queryContext,
+ )
s.createQueryHistory(database, store.QueryHistoryTypeQuery, request.Statement, user.ID, duration, queryErr)
response := &v1pb.AdminExecuteResponse{}
@@ -196,7 +214,13 @@ func (s *SQLService) Query(ctx context.Context, req *connect.Request[v1pb.QueryR
}
startTime := time.Now()
- queryRestriction := getMaximumSQLResultLimit(ctx, s.store, s.licenseService, request.Limit)
+ queryRestriction := getEffectiveQueryDataPolicy(
+ ctx,
+ s.store,
+ s.licenseService,
+ request.Limit,
+ database.ProjectID,
+ )
queryContext := db.QueryContext{
Explain: request.Explain,
Limit: int(queryRestriction.MaximumResultRows),
@@ -208,6 +232,10 @@ func (s *SQLService) Query(ctx context.Context, req *connect.Request[v1pb.QueryR
if request.Schema != nil {
queryContext.Schema = *request.Schema
}
+ if queryRestriction.MaxQueryTimeoutInSeconds > 0 {
+ queryContext.Timeout = &durationpb.Duration{Seconds: queryRestriction.MaxQueryTimeoutInSeconds}
+ }
+
results, _, duration, queryErr := queryRetryStopOnError(
ctx,
s.store,
@@ -279,26 +307,30 @@ func (s *SQLService) Query(ctx context.Context, req *connect.Request[v1pb.QueryR
return connect.NewResponse(response), nil
}
-func getMaximumSQLResultLimit(
+func getEffectiveQueryDataPolicy(
ctx context.Context,
stores *store.Store,
licenseService *enterprise.LicenseService,
limit int32,
-) *storepb.QueryDataPolicy {
- value := &storepb.QueryDataPolicy{
+ projectID string,
+) *store.EffectiveQueryDataPolicy {
+ value := &store.EffectiveQueryDataPolicy{
MaximumResultSize: common.DefaultMaximumSQLResultSize,
- MaximumResultRows: -1,
+ MaximumResultRows: math.MaxInt32,
}
if err := licenseService.IsFeatureEnabled(v1pb.PlanFeature_FEATURE_QUERY_POLICY); err == nil {
- policy, err := stores.GetQueryDataPolicy(ctx)
+ policy, err := stores.GetEffectiveQueryDataPolicy(ctx, common.FormatProject(projectID))
if err != nil {
slog.Error("failed to get the query data policy", log.BBError(err))
return value
}
value = policy
}
- if limit > 0 && (value.GetMaximumResultRows() < 0 || limit < value.GetMaximumResultRows()) {
- value.MaximumResultRows = limit
+ if limit > 0 {
+ value.MaximumResultRows = min(limit, value.MaximumResultRows)
+ }
+ if value.MaximumResultRows == math.MaxInt32 {
+ value.MaximumResultRows = 0
}
return value
}
@@ -486,7 +518,13 @@ func queryRetry(
}
slog.Debug("start execute with timeout", slog.String("instance", instance.ResourceID), slog.String("database", database.DatabaseName), slog.String("statement", statement))
- results, duration, queryErr := executeWithTimeout(ctx, stores, licenseService, driver, conn, statement, queryContext)
+ results, duration, queryErr := executeWithTimeout(
+ ctx,
+ driver,
+ conn,
+ statement,
+ queryContext,
+ )
if queryErr != nil {
return nil, nil, duration, queryErr
}
@@ -748,25 +786,25 @@ func queryRetryStopOnError(
return allResults, allSpans, totalDuration, nil
}
-func executeWithTimeout(ctx context.Context, stores *store.Store, licenseService *enterprise.LicenseService, driver db.Driver, conn *sql.Conn, statement string, queryContext db.QueryContext) ([]*v1pb.QueryResult, time.Duration, error) {
+func executeWithTimeout(
+ ctx context.Context,
+ driver db.Driver,
+ conn *sql.Conn,
+ statement string,
+ queryContext db.QueryContext,
+) ([]*v1pb.QueryResult, time.Duration, error) {
queryCtx := ctx
var timeout time.Duration
// For access control feature, we will use the timeout from request and query data policy.
// Otherwise, no timeout will be applied.
- if licenseService.IsFeatureEnabled(v1pb.PlanFeature_FEATURE_QUERY_POLICY) == nil {
- queryDataPolicy, err := stores.GetQueryDataPolicy(ctx)
- if err != nil {
- return nil, time.Duration(0), errors.Wrap(err, "failed to get query data policy")
- }
- // Override the timeout if the query data policy has a smaller timeout.
- if queryDataPolicy.Timeout.GetSeconds() > 0 || queryDataPolicy.Timeout.GetNanos() > 0 {
- timeout = queryDataPolicy.Timeout.AsDuration()
- slog.Debug("create query context with timeout", slog.Duration("timeout", timeout))
- newCtx, cancelCtx := context.WithTimeout(ctx, timeout)
- defer cancelCtx()
- queryCtx = newCtx
- }
+ if queryContext.Timeout != nil {
+ timeout = queryContext.Timeout.AsDuration()
+ slog.Debug("create query context with timeout", slog.Duration("timeout", timeout))
+ newCtx, cancelCtx := context.WithTimeout(ctx, timeout)
+ defer cancelCtx()
+ queryCtx = newCtx
}
+
start := time.Now()
result, err := driver.QueryConn(queryCtx, conn, statement, queryContext)
select {
@@ -792,21 +830,24 @@ func (s *SQLService) Export(ctx context.Context, req *connect.Request[v1pb.Expor
return connect.NewResponse(response), nil
}
- // Check if data export is allowed.
- queryDataPolicy, err := s.store.GetQueryDataPolicy(ctx)
- if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to get data export policy: %v", err))
- }
- if queryDataPolicy.DisableExport {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("data export is not allowed"))
- }
-
// Prepare related message.
user, instance, database, err := s.prepareRelatedMessage(ctx, request.Name)
if err != nil {
return nil, err
}
+ // Check if data export is allowed.
+ queryDataPolicy := getEffectiveQueryDataPolicy(
+ ctx,
+ s.store,
+ s.licenseService,
+ request.Limit,
+ database.ProjectID,
+ )
+ if queryDataPolicy.DisableExport {
+ return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("data export is not allowed"))
+ }
+
statement := request.Statement
// In Redshift datashare, Rewrite query used for parser.
if database.Metadata.GetDatashare() {
@@ -970,12 +1011,21 @@ func DoExport(
}
defer conn.Close()
}
- queryRestriction := getMaximumSQLResultLimit(ctx, stores, licenseService, request.Limit)
+ queryRestriction := getEffectiveQueryDataPolicy(
+ ctx,
+ stores,
+ licenseService,
+ request.Limit,
+ database.ProjectID,
+ )
queryContext := db.QueryContext{
Limit: int(queryRestriction.MaximumResultRows),
OperatorEmail: user.Email,
MaximumSQLResultSize: queryRestriction.MaximumResultSize,
}
+ if queryRestriction.MaxQueryTimeoutInSeconds > 0 {
+ queryContext.Timeout = &durationpb.Duration{Seconds: queryRestriction.MaxQueryTimeoutInSeconds}
+ }
if request.Schema != nil {
queryContext.Schema = *request.Schema
}
diff --git a/backend/common/resource_name.go b/backend/common/resource_name.go
index c3569d6676..15feabac19 100644
--- a/backend/common/resource_name.go
+++ b/backend/common/resource_name.go
@@ -6,7 +6,10 @@ import (
"strconv"
"strings"
+ "connectrpc.com/connect"
"github.com/pkg/errors"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
)
// nolint:revive
@@ -610,3 +613,34 @@ func FormatPlan(projectID string, planUID int64) string {
func FormatPlanCheckRun(projectID string, planUID, runUID int64) string {
return fmt.Sprintf("%s/%s%d", FormatPlan(projectID, planUID), PlanCheckRunPrefix, runUID)
}
+
+func GetPolicyResourceTypeAndResource(requestName string) (storepb.Policy_Resource, *string, error) {
+ if requestName == "" {
+ return storepb.Policy_WORKSPACE, nil, nil
+ }
+
+ if strings.HasPrefix(requestName, ProjectNamePrefix) {
+ projectID, err := GetProjectID(requestName)
+ if err != nil {
+ return storepb.Policy_RESOURCE_UNSPECIFIED, nil, connect.NewError(connect.CodeInvalidArgument, err)
+ }
+ if projectID == "-" {
+ return storepb.Policy_PROJECT, nil, nil
+ }
+ return storepb.Policy_PROJECT, &requestName, nil
+ }
+
+ if strings.HasPrefix(requestName, EnvironmentNamePrefix) {
+ // environment policy request name should be environments/{environment id}
+ environmentID, err := GetEnvironmentID(requestName)
+ if err != nil {
+ return storepb.Policy_RESOURCE_UNSPECIFIED, nil, err
+ }
+ if environmentID == "-" {
+ return storepb.Policy_ENVIRONMENT, nil, nil
+ }
+ return storepb.Policy_ENVIRONMENT, &requestName, nil
+ }
+
+ return storepb.Policy_RESOURCE_UNSPECIFIED, nil, errors.Errorf("unknown request name %s", requestName)
+}
diff --git a/backend/plugin/db/driver.go b/backend/plugin/db/driver.go
index cd8abe5ad1..532ab784d9 100644
--- a/backend/plugin/db/driver.go
+++ b/backend/plugin/db/driver.go
@@ -11,6 +11,7 @@ import (
"time"
"github.com/pkg/errors"
+ "google.golang.org/protobuf/types/known/durationpb"
"github.com/bytebase/bytebase/backend/common/log"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -124,6 +125,7 @@ type QueryContext struct {
Option *v1pb.QueryOption
// The maximum number of bytes for sql results in response body.
MaximumSQLResultSize int64
+ Timeout *durationpb.Duration
}
// Driver is the interface for database driver.
diff --git a/backend/store/policy.go b/backend/store/policy.go
index 39b4a66580..b8784fe87c 100644
--- a/backend/store/policy.go
+++ b/backend/store/policy.go
@@ -5,6 +5,7 @@ import (
"database/sql"
"fmt"
"log/slog"
+ "math"
"slices"
"time"
@@ -172,9 +173,68 @@ func (s *Store) GetRolloutPolicy(ctx context.Context, environment string) (*stor
return p, nil
}
-func (s *Store) GetQueryDataPolicy(ctx context.Context) (*storepb.QueryDataPolicy, error) {
- resourceType := storepb.Policy_WORKSPACE
- resource := ""
+type EffectiveQueryDataPolicy struct {
+ MaximumResultSize int64
+ MaximumResultRows int32
+ DisableCopyData bool
+ DisableExport bool
+ MaxQueryTimeoutInSeconds int64
+}
+
+func formatEffectiveQueryDataPolicy(policy *storepb.QueryDataPolicy) *EffectiveQueryDataPolicy {
+ maximumResultSize := policy.GetMaximumResultSize()
+ if maximumResultSize <= 0 {
+ maximumResultSize = common.DefaultMaximumSQLResultSize
+ }
+ maximumResultRows := policy.GetMaximumResultRows()
+ if maximumResultRows <= 0 {
+ maximumResultRows = math.MaxInt32
+ }
+ timeoutInSeconds := policy.GetTimeout().GetSeconds()
+ if timeoutInSeconds <= 0 {
+ timeoutInSeconds = math.MaxInt64
+ }
+
+ return &EffectiveQueryDataPolicy{
+ MaximumResultSize: maximumResultSize,
+ MaximumResultRows: maximumResultRows,
+ MaxQueryTimeoutInSeconds: timeoutInSeconds,
+ DisableCopyData: policy.GetDisableCopyData(),
+ DisableExport: policy.GetDisableExport(),
+ }
+}
+
+func (s *Store) GetEffectiveQueryDataPolicy(ctx context.Context, project string) (*EffectiveQueryDataPolicy, error) {
+ projectPolicy, err := s.getQueryDataPolicy(ctx, project)
+ if err != nil {
+ return nil, err
+ }
+ workspacePolicy, err := s.getQueryDataPolicy(ctx, "")
+ if err != nil {
+ return nil, err
+ }
+
+ formatPorjectPolicy := formatEffectiveQueryDataPolicy(projectPolicy)
+ formatWorkspacePolicy := formatEffectiveQueryDataPolicy(workspacePolicy)
+
+ maximumResultSize := min(formatPorjectPolicy.MaximumResultSize, formatWorkspacePolicy.MaximumResultSize)
+ maximumResultRows := min(formatPorjectPolicy.MaximumResultRows, formatWorkspacePolicy.MaximumResultRows)
+ maximumTimeout := min(formatPorjectPolicy.MaxQueryTimeoutInSeconds, formatWorkspacePolicy.MaxQueryTimeoutInSeconds)
+
+ return &EffectiveQueryDataPolicy{
+ DisableCopyData: formatPorjectPolicy.DisableCopyData || formatWorkspacePolicy.DisableCopyData,
+ DisableExport: formatPorjectPolicy.DisableExport || formatWorkspacePolicy.DisableExport,
+ MaximumResultSize: maximumResultSize,
+ MaximumResultRows: maximumResultRows,
+ MaxQueryTimeoutInSeconds: maximumTimeout,
+ }, nil
+}
+
+func (s *Store) getQueryDataPolicy(ctx context.Context, resource string) (*storepb.QueryDataPolicy, error) {
+ resourceType, _, err := common.GetPolicyResourceTypeAndResource(resource)
+ if err != nil {
+ return nil, err
+ }
pType := storepb.Policy_QUERY_DATA
policy, err := s.GetPolicyV2(ctx, &FindPolicyMessage{
ResourceType: &resourceType,
@@ -186,10 +246,7 @@ func (s *Store) GetQueryDataPolicy(ctx context.Context) (*storepb.QueryDataPolic
}
if policy == nil {
return &storepb.QueryDataPolicy{
- Timeout: &durationpb.Duration{},
- DisableExport: false,
- MaximumResultSize: common.DefaultMaximumSQLResultSize,
- MaximumResultRows: -1,
+ Timeout: &durationpb.Duration{},
}, nil
}
@@ -197,9 +254,6 @@ func (s *Store) GetQueryDataPolicy(ctx context.Context) (*storepb.QueryDataPolic
if err := common.ProtojsonUnmarshaler.Unmarshal([]byte(policy.Payload), p); err != nil {
return nil, errors.Wrapf(err, "failed to unmarshal query data policy")
}
- if p.MaximumResultSize <= 0 {
- p.MaximumResultSize = common.DefaultMaximumSQLResultSize
- }
return p, nil
}
diff --git a/frontend/src/components/DataExportButton.vue b/frontend/src/components/DataExportButton.vue
index 4c2e380c79..9f6a292916 100644
--- a/frontend/src/components/DataExportButton.vue
+++ b/frontend/src/components/DataExportButton.vue
@@ -42,7 +42,11 @@
>
<slot name="form" />
<NFormItem path="limit" :label="$t('export-data.export-rows')">
- <MaxRowCountSelect v-model:value="formData.limit" />
+ <MaxRowCountSelect
+ ref="maxRowCountSelectRef"
+ :maximum-export-count="maximumExportCount"
+ v-model:value="formData.limit"
+ />
</NFormItem>
<NFormItem path="format" :label="$t('export-data.export-format')">
<NRadioGroup v-model:value="formData.format">
@@ -133,7 +137,7 @@ import {
NRadioGroup,
NTooltip,
} from "naive-ui";
-import { computed, reactive, ref, watch } from "vue";
+import { computed, nextTick, reactive, ref, watch } from "vue";
import { BBModal, BBTextField } from "@/bbkit";
import { t } from "@/plugins/i18n";
import { pushNotification } from "@/store";
@@ -169,6 +173,7 @@ const props = withDefaults(
tooltip?: string;
text?: string;
validate?: (option: ExportOption) => boolean;
+ maximumExportCount?: number;
}>(),
{
size: "small",
@@ -177,11 +182,17 @@ const props = withDefaults(
supportPassword: false,
text: () => t("common.export"),
validate: (_: ExportOption) => true,
+ maximumExportCount: Number.MAX_VALUE,
}
);
+const maxRowCountSelectRef = ref<InstanceType<typeof MaxRowCountSelect>>();
+
const defaultFormData = (): ExportOption => ({
- limit: 1000,
+ limit: Math.min(
+ maxRowCountSelectRef.value?.maximum ?? Number.MAX_VALUE,
+ 1000
+ ),
format: props.supportFormats[0],
password: "",
});
@@ -385,6 +396,12 @@ watch(
([showDrawer, showModal]) => {
if (showDrawer) {
formData.value = defaultFormData();
+ nextTick(() => {
+ formData.value.limit = Math.min(
+ maxRowCountSelectRef.value?.maximum ?? Number.MAX_VALUE,
+ formData.value.limit
+ );
+ });
} else if (showModal) {
formData.value.password = "";
}
diff --git a/frontend/src/components/EnvironmentForm/AccessControlConfigure.vue b/frontend/src/components/EnvironmentForm/AccessControlConfigure.vue
index b4e509e9c4..6ca31c9226 100644
--- a/frontend/src/components/EnvironmentForm/AccessControlConfigure.vue
+++ b/frontend/src/components/EnvironmentForm/AccessControlConfigure.vue
@@ -4,6 +4,14 @@
<label>
{{ t("environment.access-control.title") }}
</label>
+ <NTooltip v-if="tooltip">
+ <template #trigger>
+ <CircleQuestionMarkIcon class="w-4 textinfolabel" />
+ </template>
+ <span>
+ {{ tooltip }}
+ </span>
+ </NTooltip>
</div>
<div>
<div class="w-full inline-flex items-center gap-x-2">
@@ -77,7 +85,7 @@
<Switch
v-model:value="state.dataSourceQueryPolicy.disallowDdl"
:text="true"
- :disabled="!allowUpdatePolicy || !hasRestrictDDLDMLFeature"
+ :disabled="!allowUpdatePolicy || !hasRestrictQueryDataSourceFeature"
/>
<span class="textlabel">
{{ t("environment.statement-execution.disallow-ddl") }}
@@ -87,7 +95,7 @@
<Switch
v-model:value="state.dataSourceQueryPolicy.disallowDml"
:text="true"
- :disabled="!allowUpdatePolicy || !hasRestrictDDLDMLFeature"
+ :disabled="!allowUpdatePolicy || !hasRestrictQueryDataSourceFeature"
/>
<span class="textlabel">
{{ t("environment.statement-execution.disallow-dml") }}
@@ -100,11 +108,15 @@
<script setup lang="ts">
import { create as createProto } from "@bufbuild/protobuf";
import { cloneDeep, isEqual } from "lodash-es";
-import { NRadio, NRadioGroup } from "naive-ui";
+import { CircleQuestionMarkIcon } from "lucide-vue-next";
+import { NRadio, NRadioGroup, NTooltip } from "naive-ui";
import { computed, reactive, watchEffect } from "vue";
import { useI18n } from "vue-i18n";
import { hasFeature, usePolicyV1Store } from "@/store";
-import { environmentNamePrefix } from "@/store/modules/v1/common";
+import {
+ environmentNamePrefix,
+ projectNamePrefix,
+} from "@/store/modules/v1/common";
import type {
DataSourceQueryPolicy,
QueryDataPolicy,
@@ -132,6 +144,25 @@ const props = defineProps<{
allowEdit: boolean;
}>();
+const scope = computed(() => {
+ if (props.resource.startsWith(projectNamePrefix)) {
+ return t("settings.general.workspace.query-data-policy.environment-scope");
+ }
+ if (props.resource.startsWith(environmentNamePrefix)) {
+ return t("settings.general.workspace.query-data-policy.project-scope");
+ }
+ return "";
+});
+
+const tooltip = computed(() => {
+ if (!scope.value) {
+ return "";
+ }
+ return t("settings.general.workspace.query-data-policy.tooltip", {
+ scope: scope.value,
+ });
+});
+
const policyStore = usePolicyV1Store();
const getInitialState = (): LocalState => {
@@ -194,10 +225,6 @@ const hasRestrictCopyingDataFeature = computed(() =>
hasFeature(PlanFeature.FEATURE_RESTRICT_COPYING_DATA)
);
-const hasRestrictDDLDMLFeature = computed(() =>
- hasFeature(PlanFeature.FEATURE_QUERY_POLICY)
-);
-
const allowUpdatePolicy = computed(() => {
return props.allowEdit && hasWorkspacePermissionV2("bb.policies.update");
});
diff --git a/frontend/src/components/GeneralSetting/MaximumSQLResultSizeSetting.vue b/frontend/src/components/GeneralSetting/MaximumSQLResultSizeSetting.vue
index f19844b65d..a80d118af9 100644
--- a/frontend/src/components/GeneralSetting/MaximumSQLResultSizeSetting.vue
+++ b/frontend/src/components/GeneralSetting/MaximumSQLResultSizeSetting.vue
@@ -6,6 +6,14 @@
{{ $t("settings.general.workspace.maximum-sql-result.size.self") }}
</span>
<FeatureBadge :feature="PlanFeature.FEATURE_QUERY_POLICY" />
+ <NTooltip v-if="tooltip">
+ <template #trigger>
+ <CircleQuestionMarkIcon class="w-4 textinfolabel" />
+ </template>
+ <span>
+ {{ tooltip }}
+ </span>
+ </NTooltip>
</p>
<p class="text-sm text-gray-400 mt-1">
{{
@@ -14,7 +22,7 @@
<span class="font-semibold! textinfolabel">
{{
$t("settings.general.workspace.maximum-sql-result.size.default", {
- limit: defaultMaximumResultSizeInMB,
+ limit: DEFAULT_MAX_RESULT_SIZE_IN_MB,
})
}}
</span>
@@ -22,7 +30,7 @@
<div class="mt-3 w-full flex flex-row justify-start items-center gap-4">
<NInputNumber
:value="queryRestriction.maximumResultSize"
- :disabled="!allowEdit || !hasQueryPolicyFeature"
+ :disabled="!allowEdit"
class="w-60"
:min="1"
:precision="0"
@@ -43,6 +51,14 @@
{{ $t("settings.general.workspace.maximum-sql-result.rows.self") }}
</span>
<FeatureBadge :feature="PlanFeature.FEATURE_QUERY_POLICY" />
+ <NTooltip v-if="tooltip">
+ <template #trigger>
+ <CircleQuestionMarkIcon class="w-4 textinfolabel" />
+ </template>
+ <span>
+ {{ tooltip }}
+ </span>
+ </NTooltip>
</p>
<p class="text-sm text-gray-400 mt-1">
{{
@@ -55,7 +71,7 @@
<div class="mt-3 w-full flex flex-row justify-start items-center gap-4">
<NInputNumber
:value="queryRestriction.maximumResultRows"
- :disabled="!allowEdit || !hasQueryPolicyFeature"
+ :disabled="!allowEdit"
class="w-60"
:min="-1"
:precision="0"
@@ -78,54 +94,34 @@
<script lang="ts" setup>
import { create } from "@bufbuild/protobuf";
import { isEqual } from "lodash-es";
-import { NInputNumber } from "naive-ui";
+import { CircleQuestionMarkIcon } from "lucide-vue-next";
+import { NInputNumber, NTooltip } from "naive-ui";
import { computed, ref } from "vue";
-import {
- featureToRef,
- usePolicyByParentAndType,
- usePolicyV1Store,
-} from "@/store";
+import { DEFAULT_MAX_RESULT_SIZE_IN_MB, usePolicyV1Store } from "@/store";
import {
PolicyResourceType,
PolicyType,
+ type QueryDataPolicy,
QueryDataPolicySchema,
} from "@/types/proto-es/v1/org_policy_service_pb";
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import { FeatureBadge } from "../FeatureGuard";
-defineProps<{
+const props = defineProps<{
allowEdit: boolean;
+ resource: string;
+ policy: QueryDataPolicy;
+ tooltip?: string;
}>();
const policyV1Store = usePolicyV1Store();
-const timing = ref<ReturnType<typeof setTimeout>>();
-const hasQueryPolicyFeature = featureToRef(PlanFeature.FEATURE_QUERY_POLICY);
-const defaultMaximumResultSizeInMB = 100;
-
-const { policy: queryDataPolicy } = usePolicyByParentAndType(
- computed(() => ({
- parentPath: "",
- policyType: PolicyType.DATA_QUERY,
- }))
-);
-
-const policyPayload = computed(() => {
- return queryDataPolicy.value?.policy?.case === "queryDataPolicy"
- ? queryDataPolicy.value.policy.value
- : create(QueryDataPolicySchema);
-});
const initialState = () => {
return {
maximumResultSize: Math.round(
- Number(
- policyPayload.value.maximumResultSize ??
- BigInt(defaultMaximumResultSizeInMB * 1024 * 1024)
- ) /
- 1024 /
- 1024
+ Number(props.policy.maximumResultSize) / 1024 / 1024
),
- maximumResultRows: Number(policyPayload.value.maximumResultRows ?? -1),
+ maximumResultRows: Number(props.policy.maximumResultRows),
};
};
@@ -139,16 +135,15 @@ const allowUpdate = computed(() => {
});
const updateChange = async () => {
- clearTimeout(timing.value);
await policyV1Store.upsertPolicy({
- parentPath: "",
+ parentPath: props.resource,
policy: {
type: PolicyType.DATA_QUERY,
resourceType: PolicyResourceType.WORKSPACE,
policy: {
case: "queryDataPolicy",
value: create(QueryDataPolicySchema, {
- ...policyPayload.value,
+ ...props.policy,
maximumResultSize: BigInt(
queryRestriction.value.maximumResultSize * 1024 * 1024
),
diff --git a/frontend/src/components/GeneralSetting/QueryDataPolicySetting.vue b/frontend/src/components/GeneralSetting/QueryDataPolicySetting.vue
index 13fdc617ea..9838ea5c7c 100644
--- a/frontend/src/components/GeneralSetting/QueryDataPolicySetting.vue
+++ b/frontend/src/components/GeneralSetting/QueryDataPolicySetting.vue
@@ -1,10 +1,50 @@
<template>
- <div>
+ <div class="flex-1 flex flex-col gap-y-7">
+ <div>
+ <div class="flex items-center gap-x-2">
+ <Switch
+ :value="!disableExport"
+ :text="true"
+ :disabled="!allowEdit"
+ @update:value="(val: boolean) => disableExport = !val"
+ />
+ <span class="font-medium">
+ {{ $t("settings.general.workspace.data-export.enable") }}
+ </span>
+ <NTooltip v-if="scope">
+ <template #trigger>
+ <CircleQuestionMarkIcon class="w-4 textinfolabel" />
+ </template>
+ <span>
+ {{ $t("settings.general.workspace.query-data-policy.tooltip", { scope }) }}
+ </span>
+ </NTooltip>
+ </div>
+ <div class="mt-1 text-sm text-gray-400">
+ {{ $t("settings.general.workspace.data-export.description") }}
+ </div>
+ </div>
+ <MaximumSQLResultSizeSetting
+ ref="maximumSQLResultSizeSettingRef"
+ :allow-edit="allowEdit"
+ :resource="resource"
+ :policy="policyPayload"
+ :tooltip="scope ? $t('settings.general.workspace.query-data-policy.tooltip', { scope }) : ''"
+ />
+ <div>
<p class="font-medium flex flex-row justify-start items-center">
<span class="mr-2">
{{ $t("settings.general.workspace.query-data-policy.timeout.self") }}
</span>
<FeatureBadge :feature="PlanFeature.FEATURE_QUERY_POLICY" />
+ <NTooltip v-if="scope">
+ <template #trigger>
+ <CircleQuestionMarkIcon class="w-4 textinfolabel" />
+ </template>
+ <span>
+ {{ $t("settings.general.workspace.query-data-policy.tooltip", { scope }) }}
+ </span>
+ </NTooltip>
</p>
<p class="text-sm text-gray-400 mt-1">
{{
@@ -16,7 +56,7 @@
</p>
<div class="mt-3 w-full flex flex-row justify-start items-center gap-4">
<NInputNumber
- :value="seconds"
+ :value="maxQueryTimeInseconds"
:disabled="!allowEdit"
class="w-60"
:min="0"
@@ -29,18 +69,23 @@
</NInputNumber>
</div>
</div>
+ </div>
</template>
<script lang="ts" setup>
import { create } from "@bufbuild/protobuf";
import { DurationSchema } from "@bufbuild/protobuf/wkt";
-import { NInputNumber } from "naive-ui";
-import { computed, ref } from "vue";
+import { CircleQuestionMarkIcon } from "lucide-vue-next";
+import { NInputNumber, NTooltip } from "naive-ui";
+import { computed, ref, watch } from "vue";
+import { Switch } from "@/components/v2";
+import { t } from "@/plugins/i18n";
import {
featureToRef,
usePolicyByParentAndType,
usePolicyV1Store,
} from "@/store";
+import { projectNamePrefix } from "@/store/modules/v1/common";
import {
PolicyResourceType,
PolicyType,
@@ -49,50 +94,93 @@ import {
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import { hasWorkspacePermissionV2 } from "@/utils";
import { FeatureBadge } from "../FeatureGuard";
+import MaximumSQLResultSizeSetting from "./MaximumSQLResultSizeSetting.vue";
+
+const props = defineProps<{
+ resource: string;
+}>();
const policyV1Store = usePolicyV1Store();
const hasQueryPolicyFeature = featureToRef(PlanFeature.FEATURE_QUERY_POLICY);
-const { policy: queryDataPolicy } = usePolicyByParentAndType(
+const scope = computed(() => {
+ if (props.resource.startsWith(projectNamePrefix)) {
+ return t("settings.general.workspace.query-data-policy.workspace-scope");
+ }
+ if (props.resource === "") {
+ return t("settings.general.workspace.query-data-policy.project-scope");
+ }
+ return "";
+});
+
+const { ready } = usePolicyByParentAndType(
computed(() => ({
- parentPath: "",
+ parentPath: props.resource,
policyType: PolicyType.DATA_QUERY,
}))
);
+const policyPayload = computed(() => {
+ return policyV1Store.getQueryDataPolicyByParent(props.resource);
+});
+
+const initialMaxQueryTimeInseconds = computed(() =>
+ Number(policyPayload.value.timeout?.seconds ?? 0)
+);
+
+// limit in seconds.
+const maxQueryTimeInseconds = ref<number>(initialMaxQueryTimeInseconds.value);
+const disableExport = ref(policyPayload.value.disableExport);
+
+const maximumSQLResultSizeSettingRef =
+ ref<InstanceType<typeof MaximumSQLResultSizeSetting>>();
+
+const revert = () => {
+ maxQueryTimeInseconds.value = initialMaxQueryTimeInseconds.value;
+ disableExport.value = policyPayload.value.disableExport;
+ maximumSQLResultSizeSettingRef.value?.revert();
+};
+
+watch(
+ () => ready.value,
+ (ready) => {
+ if (ready) {
+ revert();
+ }
+ }
+);
+
const allowEdit = computed(
() =>
hasWorkspacePermissionV2("bb.policies.update") &&
hasQueryPolicyFeature.value
);
-const initialState = () => {
- if (
- queryDataPolicy.value?.policy.case === "queryDataPolicy" &&
- queryDataPolicy.value.policy.value.timeout
- ) {
- return Number(queryDataPolicy.value.policy.value.timeout.seconds);
- }
- return 0;
-};
-
-// limit in seconds.
-const seconds = ref<number>(initialState());
-
-const allowUpdate = computed(() => {
- return seconds.value !== initialState();
+const isDirty = computed(() => {
+ return (
+ maxQueryTimeInseconds.value !== initialMaxQueryTimeInseconds.value ||
+ disableExport.value !== policyPayload.value.disableExport ||
+ maximumSQLResultSizeSettingRef.value?.isDirty
+ );
});
const updateChange = async () => {
+ if (maximumSQLResultSizeSettingRef.value?.isDirty) {
+ await maximumSQLResultSizeSettingRef.value.update();
+ }
await policyV1Store.upsertPolicy({
- parentPath: "",
+ parentPath: props.resource,
policy: {
type: PolicyType.DATA_QUERY,
resourceType: PolicyResourceType.WORKSPACE,
policy: {
case: "queryDataPolicy",
value: create(QueryDataPolicySchema, {
- timeout: create(DurationSchema, { seconds: BigInt(seconds.value) }),
+ ...policyPayload.value,
+ disableExport: disableExport.value,
+ timeout: create(DurationSchema, {
+ seconds: BigInt(maxQueryTimeInseconds.value),
+ }),
}),
},
},
@@ -102,12 +190,12 @@ const updateChange = async () => {
const handleInput = (value: number | null) => {
if (value === null) return;
if (value === undefined) return;
- seconds.value = value;
+ maxQueryTimeInseconds.value = value;
};
defineExpose({
- isDirty: allowUpdate,
+ isDirty,
update: updateChange,
- revert: () => (seconds.value = initialState()),
+ revert,
});
</script>
diff --git a/frontend/src/components/GeneralSetting/SecuritySetting.vue b/frontend/src/components/GeneralSetting/SecuritySetting.vue
index 61d85339dc..7f1728bdd2 100644
--- a/frontend/src/components/GeneralSetting/SecuritySetting.vue
+++ b/frontend/src/components/GeneralSetting/SecuritySetting.vue
@@ -15,7 +15,7 @@
<div>
<div class="flex items-center gap-x-2">
<Switch
- v-model:value="state.enableWatermark"
+ v-model:value="enableWatermark"
:text="true"
:disabled="!allowEdit || !hasWatermarkFeature"
/>
@@ -24,30 +24,14 @@
</span>
<FeatureBadge :feature="PlanFeature.FEATURE_WATERMARK" />
</div>
- <div class="mt-1 mb-3 text-sm text-gray-400">
+ <div class="mt-1 text-sm text-gray-400">
{{ $t("settings.general.workspace.watermark.description") }}
</div>
</div>
- <div>
- <div class="flex items-center gap-x-2">
- <Switch
- v-model:value="state.enableDataExport"
- :text="true"
- :disabled="!allowEdit"
- />
- <span class="font-medium">
- {{ $t("settings.general.workspace.data-export.enable") }}
- </span>
- </div>
- <div class="mt-1 mb-3 text-sm text-gray-400">
- {{ $t("settings.general.workspace.data-export.description") }}
- </div>
- </div>
- <MaximumSQLResultSizeSetting
- ref="maximumSQLResultSizeSettingRef"
- :allow-edit="allowEdit"
+ <QueryDataPolicySetting
+ ref="queryDataPolicySettingRef"
+ resource=""
/>
- <QueryDataPolicySetting ref="queryDataPolicySettingRef" />
<MaximumRoleExpirationSetting
ref="maximumRoleExpirationSettingRef"
:allow-edit="allowEdit"
@@ -62,20 +46,9 @@
<script lang="ts" setup>
import { create } from "@bufbuild/protobuf";
-import { isEqual } from "lodash-es";
-import { computed, reactive, ref } from "vue";
+import { computed, ref } from "vue";
import { Switch } from "@/components/v2";
-import {
- featureToRef,
- usePolicyByParentAndType,
- usePolicyV1Store,
- useSettingV1Store,
-} from "@/store";
-import {
- PolicyResourceType,
- PolicyType,
- QueryDataPolicySchema,
-} from "@/types/proto-es/v1/org_policy_service_pb";
+import { featureToRef, useSettingV1Store } from "@/store";
import {
Setting_SettingName,
ValueSchema as SettingValueSchema,
@@ -84,96 +57,50 @@ import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
import { FeatureBadge } from "../FeatureGuard";
import DomainRestrictionSetting from "./DomainRestrictionSetting.vue";
import MaximumRoleExpirationSetting from "./MaximumRoleExpirationSetting.vue";
-import MaximumSQLResultSizeSetting from "./MaximumSQLResultSizeSetting.vue";
import QueryDataPolicySetting from "./QueryDataPolicySetting.vue";
-interface LocalState {
- enableWatermark: boolean;
- enableDataExport: boolean;
-}
-
const props = defineProps<{
title: string;
allowEdit: boolean;
}>();
const settingV1Store = useSettingV1Store();
-const policyV1Store = usePolicyV1Store();
const hasWatermarkFeature = featureToRef(PlanFeature.FEATURE_WATERMARK);
const domainRestrictionSettingRef =
ref<InstanceType<typeof DomainRestrictionSetting>>();
const maximumRoleExpirationSettingRef =
ref<InstanceType<typeof MaximumRoleExpirationSetting>>();
-const maximumSQLResultSizeSettingRef =
- ref<InstanceType<typeof MaximumSQLResultSizeSetting>>();
const queryDataPolicySettingRef =
ref<InstanceType<typeof QueryDataPolicySetting>>();
const settingRefList = computed(() => [
domainRestrictionSettingRef,
maximumRoleExpirationSettingRef,
- maximumSQLResultSizeSettingRef,
queryDataPolicySettingRef,
]);
-const { policy: queryDataPolicy } = usePolicyByParentAndType(
- computed(() => ({
- parentPath: "",
- policyType: PolicyType.DATA_QUERY,
- }))
-);
-
-const policyPayload = computed(() => {
- return queryDataPolicy.value?.policy?.case === "queryDataPolicy"
- ? queryDataPolicy.value.policy.value
- : create(QueryDataPolicySchema);
-});
-
-const getInitialState = (): LocalState => {
+const initEnableWatermark = computed(() => {
const watermarkSetting = settingV1Store.getSettingByName(
Setting_SettingName.WATERMARK
);
- let enableWatermark = false;
if (watermarkSetting?.value?.value?.case === "stringValue") {
- enableWatermark = watermarkSetting.value.value.value === "1";
+ return watermarkSetting.value.value.value === "1";
}
- return {
- enableWatermark,
- enableDataExport: !policyPayload.value.disableExport,
- };
-};
-
-const state = reactive<LocalState>({
- ...getInitialState(),
+ return false;
});
+const enableWatermark = ref(initEnableWatermark.value);
+
const isDirty = computed(() => {
return (
- !isEqual(state, getInitialState()) ||
+ enableWatermark.value !== initEnableWatermark.value ||
settingRefList.value.some((settingRef) => settingRef.value?.isDirty)
);
});
-const handleDataExportToggle = async () => {
- await policyV1Store.upsertPolicy({
- parentPath: "",
- policy: {
- type: PolicyType.DATA_QUERY,
- resourceType: PolicyResourceType.WORKSPACE,
- policy: {
- case: "queryDataPolicy",
- value: create(QueryDataPolicySchema, {
- ...policyPayload.value,
- disableExport: !state.enableDataExport,
- }),
- },
- },
- });
-};
-
const handleWatermarkToggle = async () => {
- const value = state.enableWatermark ? "1" : "0";
+ const value = enableWatermark.value ? "1" : "0";
await settingV1Store.upsertSetting({
name: Setting_SettingName.WATERMARK,
value: create(SettingValueSchema, {
@@ -191,12 +118,9 @@ const onUpdate = async () => {
await settingRef.value.update();
}
}
- if (state.enableWatermark !== getInitialState().enableWatermark) {
+ if (enableWatermark.value !== initEnableWatermark.value) {
await handleWatermarkToggle();
}
- if (state.enableDataExport !== getInitialState().enableDataExport) {
- await handleDataExportToggle();
- }
};
defineExpose({
@@ -204,7 +128,7 @@ defineExpose({
update: onUpdate,
title: props.title,
revert: () => {
- Object.assign(state, getInitialState());
+ enableWatermark.value = initEnableWatermark.value;
for (const settingRef of settingRefList.value) {
settingRef.value?.revert();
}
diff --git a/frontend/src/components/GrantRequestPanel/MaxRowCountSelect.vue b/frontend/src/components/GrantRequestPanel/MaxRowCountSelect.vue
index edea5b57ff..bd6143d945 100644
--- a/frontend/src/components/GrantRequestPanel/MaxRowCountSelect.vue
+++ b/frontend/src/components/GrantRequestPanel/MaxRowCountSelect.vue
@@ -7,8 +7,17 @@
scrollable
@update:value="handleUpdateValue"
>
- <NButton class="bb-overlay-stack-ignore-esc">
+ <NButton
+ icon-placement="right"
+ :quaternary="quaternary"
+ class="bb-overlay-stack-ignore-esc"
+ style="justify-content: start; --n-padding: 0 8px;"
+ >
+ {{ $t("sql-editor.result-limit.self") }}
{{ $t("common.rows.n-rows", { n: value }) }}
+ <template #icon>
+ <ChevronRight />
+ </template>
</NButton>
<template #action>
<div class="flex items-center justify-between gap-1">
@@ -28,14 +37,16 @@
<script setup lang="ts">
import { first, last } from "lodash-es";
+import { ChevronRight } from "lucide-vue-next";
import { NButton, NInputNumber, NPopselect, type SelectOption } from "naive-ui";
import { computed } from "vue";
import { useI18n } from "vue-i18n";
-import { usePolicyV1Store } from "@/store";
import { minmax } from "@/utils";
-defineProps<{
+const props = defineProps<{
value: number;
+ quaternary?: boolean;
+ maximumExportCount: number;
}>();
const emit = defineEmits<{
@@ -43,17 +54,16 @@ const emit = defineEmits<{
}>();
const { t } = useI18n();
-const policyStore = usePolicyV1Store();
const rowCountOptions = computed(() => {
const list = [1, 100, 500, 1000, 5000, 10000, 100000].filter(
- (num) => num <= policyStore.maximumResultRows
+ (num) => num <= props.maximumExportCount
);
if (
- policyStore.maximumResultRows !== Number.MAX_VALUE &&
- !list.includes(policyStore.maximumResultRows)
+ props.maximumExportCount !== Number.MAX_VALUE &&
+ !list.includes(props.maximumExportCount)
) {
- list.push(policyStore.maximumResultRows);
+ list.push(props.maximumExportCount);
}
return list;
});
@@ -77,4 +87,8 @@ const handleInput = (value: number | null) => {
);
emit("update:value", normalizedValue);
};
+
+defineExpose({
+ maximum: computed(() => rowCountOptions.value.slice(-1)[0]),
+});
</script>
diff --git a/frontend/src/components/Project/Settings/ProjectSecuritySettingPanel.vue b/frontend/src/components/Project/Settings/ProjectSecuritySettingPanel.vue
index 5029992d34..f4fb691b22 100644
--- a/frontend/src/components/Project/Settings/ProjectSecuritySettingPanel.vue
+++ b/frontend/src/components/Project/Settings/ProjectSecuritySettingPanel.vue
@@ -1,5 +1,5 @@
<template>
- <div class="w-full flex flex-col justify-start items-start gap-y-4">
+ <div class="w-full flex flex-col justify-start items-start gap-y-7">
<SQLReviewForResource
ref="sqlReviewForResourceRef"
:resource="project.name"
@@ -10,12 +10,17 @@
:resource="project.name"
:allow-edit="allowEdit"
/>
+ <QueryDataPolicySetting
+ ref="queryDataPolicySettingRef"
+ :resource="project.name"
+ />
</div>
</template>
<script setup lang="ts">
import { computed, ref } from "vue";
import AccessControlConfigure from "@/components/EnvironmentForm/AccessControlConfigure.vue";
+import QueryDataPolicySetting from "@/components/GeneralSetting/QueryDataPolicySetting.vue";
import { SQLReviewForResource } from "@/components/SQLReview";
import type { Project } from "@/types/proto-es/v1/project_service_pb";
@@ -28,11 +33,14 @@ const accessControlConfigureRef =
ref<InstanceType<typeof AccessControlConfigure>>();
const sqlReviewForResourceRef =
ref<InstanceType<typeof SQLReviewForResource>>();
+const queryDataPolicySettingRef =
+ ref<InstanceType<typeof QueryDataPolicySetting>>();
const isDirty = computed(
() =>
accessControlConfigureRef.value?.isDirty ||
- sqlReviewForResourceRef.value?.isDirty
+ sqlReviewForResourceRef.value?.isDirty ||
+ queryDataPolicySettingRef.value?.isDirty
);
const onUpdate = async () => {
@@ -42,11 +50,15 @@ const onUpdate = async () => {
if (accessControlConfigureRef.value?.isDirty) {
await accessControlConfigureRef.value.update();
}
+ if (queryDataPolicySettingRef.value?.isDirty) {
+ await queryDataPolicySettingRef.value.update();
+ }
};
const resetState = () => {
sqlReviewForResourceRef.value?.revert();
accessControlConfigureRef.value?.revert();
+ queryDataPolicySettingRef.value?.revert();
};
defineExpose({
diff --git a/frontend/src/components/ProjectSettingPanel.vue b/frontend/src/components/ProjectSettingPanel.vue
index c38584f71e..3020808294 100644
--- a/frontend/src/components/ProjectSettingPanel.vue
+++ b/frontend/src/components/ProjectSettingPanel.vue
@@ -55,7 +55,7 @@
<!-- Save/Cancel buttons -->
<div v-if="allowEdit && isDirty" class="sticky bottom-0 z-10">
<div
- class="flex justify-between w-full py-4 border-block-border bg-white"
+ class="flex justify-between w-full py-4 border-t border-block-border bg-white"
>
<NButton @click.prevent="onRevert">
{{ $t("common.cancel") }}
diff --git a/frontend/src/components/SQLReview/components/SQLReviewForResource.vue b/frontend/src/components/SQLReview/components/SQLReviewForResource.vue
index 4d2125b7e5..877663d6fd 100644
--- a/frontend/src/components/SQLReview/components/SQLReviewForResource.vue
+++ b/frontend/src/components/SQLReview/components/SQLReviewForResource.vue
@@ -1,8 +1,18 @@
<template>
<div class="flex flex-col gap-y-2">
- <label class="font-medium">
- {{ $t("sql-review.title") }}
- </label>
+ <div class="flex items-center gap-x-2">
+ <label class="font-medium">
+ {{ $t("sql-review.title") }}
+ </label>
+ <NTooltip v-if="tooltip">
+ <template #trigger>
+ <CircleQuestionMarkIcon class="w-4 textinfolabel" />
+ </template>
+ <span>
+ {{ tooltip }}
+ </span>
+ </NTooltip>
+ </div>
<div>
<div
v-if="pendingSelectReviewPolicy"
@@ -52,13 +62,18 @@
<script setup lang="ts">
import { isEqual } from "lodash-es";
-import { XIcon } from "lucide-vue-next";
-import { NButton } from "naive-ui";
+import { CircleQuestionMarkIcon, XIcon } from "lucide-vue-next";
+import { NButton, NTooltip } from "naive-ui";
import { computed, ref, watchEffect } from "vue";
import { useRouter } from "vue-router";
import { Switch } from "@/components/v2";
+import { t } from "@/plugins/i18n";
import { WORKSPACE_ROUTE_SQL_REVIEW_DETAIL } from "@/router/dashboard/workspaceRoutes";
import { useReviewPolicyByResource, useSQLReviewStore } from "@/store";
+import {
+ environmentNamePrefix,
+ projectNamePrefix,
+} from "@/store/modules/v1/common";
import type { SQLReviewPolicy } from "@/types";
import { hasWorkspacePermissionV2, sqlReviewPolicySlug } from "@/utils";
import SQLReviewPolicySelectPanel from "./SQLReviewPolicySelectPanel.vue";
@@ -73,6 +88,23 @@ const reviewStore = useSQLReviewStore();
const showReviewSelectPanel = ref<boolean>(false);
const pendingSelectReviewPolicy = ref<SQLReviewPolicy | undefined>(undefined);
+const scope = computed(() => {
+ if (props.resource.startsWith(projectNamePrefix)) {
+ return t("settings.general.workspace.query-data-policy.environment-scope");
+ }
+ if (props.resource.startsWith(environmentNamePrefix)) {
+ return t("settings.general.workspace.query-data-policy.project-scope");
+ }
+ return "";
+});
+
+const tooltip = computed(() => {
+ if (!scope.value) {
+ return "";
+ }
+ return t("sql-review.tooltip-for-resource", { scope: scope.value });
+});
+
const sqlReviewPolicy = useReviewPolicyByResource(
computed(() => props.resource)
);
diff --git a/frontend/src/locales/en-US.json b/frontend/src/locales/en-US.json
index 9178e5cec1..cb31b94fd0 100644
--- a/frontend/src/locales/en-US.json
+++ b/frontend/src/locales/en-US.json
@@ -645,7 +645,11 @@
"self": "Maximum query time",
"description": "The maximum time allowed for a query to run in SQL Editor."
},
- "seconds": "Seconds"
+ "seconds": "Seconds",
+ "project-scope": "project",
+ "workspace-scope": "workspace",
+ "environment-scope": "environment",
+ "tooltip": "It's also configurable at the {scope} level. Bytebase will apply the most strict value."
},
"domain-restriction": {
"self": "Workspace Domain",
@@ -2128,9 +2132,7 @@
"only-for-cluster": "Only available for cluster connection"
},
"result-limit": {
- "self": "Result limit",
- "n-rows": "{n} rows",
- "rows": "rows"
+ "self": "Result limit"
},
"n-per-page": "{n} / page",
"add-a-new-instance": "Add a new instance",
@@ -2426,7 +2428,8 @@
"name": "Level",
"error": "Error",
"warning": "Warning"
- }
+ },
+ "tooltip-for-resource": "It's also configurable at the {scope} level. Bytebase will prioritize the environment-level configuration."
},
"audit-log": {
"export-finished": "Export finished",
diff --git a/frontend/src/locales/es-ES.json b/frontend/src/locales/es-ES.json
index 078b3f4aa0..4e515f71b6 100644
--- a/frontend/src/locales/es-ES.json
+++ b/frontend/src/locales/es-ES.json
@@ -645,7 +645,11 @@
"self": "Tiempo máximo de consulta",
"description": "El tiempo máximo permitido para ejecutar una consulta en el Editor SQL."
},
- "seconds": "Artículos de segunda clase"
+ "seconds": "Artículos de segunda clase",
+ "project-scope": "proyecto",
+ "workspace-scope": "espacio de trabajo",
+ "environment-scope": "ambiente",
+ "tooltip": "También es configurable a nivel {scope}. Bytebase aplicará el valor más estricto."
},
"domain-restriction": {
"self": "Dominio de espacio de trabajo",
@@ -2128,9 +2132,7 @@
"only-for-cluster": "Sólo disponible para conexión de clúster"
},
"result-limit": {
- "self": "Límite de resultados",
- "n-rows": "{n} filas",
- "rows": "filas"
+ "self": "Límite de resultados"
},
"n-per-page": "{n} / página",
"add-a-new-instance": "Agregar una nueva instancia",
@@ -2426,7 +2428,8 @@
"name": "Nivel",
"error": "Error",
"warning": "Advertencia"
- }
+ },
+ "tooltip-for-resource": "También es configurable a nivel {scope}. Bytebase dará prioridad a la configuración a nivel de entorno."
},
"audit-log": {
"export-finished": "Exportación finalizada",
diff --git a/frontend/src/locales/ja-JP.json b/frontend/src/locales/ja-JP.json
index 587c95cd41..f32839f839 100644
--- a/frontend/src/locales/ja-JP.json
+++ b/frontend/src/locales/ja-JP.json
@@ -645,7 +645,11 @@
"self": "最大クエリ時間",
"description": "SQL エディターでクエリを実行するために許可される最大時間。"
},
- "seconds": "秒"
+ "seconds": "秒",
+ "project-scope": "プロジェクト",
+ "workspace-scope": "ワークスペース",
+ "environment-scope": "環境",
+ "tooltip": "{scope} レベルでも設定可能です。Bytebase は最も厳格な値を適用します。"
},
"domain-restriction": {
"self": "ワークスペースドメイン",
@@ -2128,9 +2132,7 @@
"only-for-cluster": "クラスタ接続のみ使用可能"
},
"result-limit": {
- "self": "結果の制限",
- "n-rows": "{n} 行",
- "rows": "行"
+ "self": "結果の制限"
},
"n-per-page": "{n} / ページ",
"add-a-new-instance": "新しいインスタンスを追加する",
@@ -2426,7 +2428,8 @@
"name": "レベル",
"error": "エラー",
"warning": "警告"
- }
+ },
+ "tooltip-for-resource": "{scope} レベルでも設定可能です。Bytebase は環境レベルの設定を優先します。"
},
"audit-log": {
"export-finished": "エクスポートが完了しました",
diff --git a/frontend/src/locales/vi-VN.json b/frontend/src/locales/vi-VN.json
index 1980bcbff2..e871fcb8ee 100644
--- a/frontend/src/locales/vi-VN.json
+++ b/frontend/src/locales/vi-VN.json
@@ -645,7 +645,11 @@
"self": "Thời gian truy vấn tối đa",
"description": "Thời gian tối đa được phép chạy truy vấn trong SQL Editor."
},
- "seconds": "Giây"
+ "seconds": "Giây",
+ "project-scope": "dự án",
+ "workspace-scope": "không gian làm việc",
+ "environment-scope": "môi trường",
+ "tooltip": "Bạn cũng có thể cấu hình ở cấp độ {scope}. Bytebase sẽ áp dụng giá trị nghiêm ngặt nhất."
},
"domain-restriction": {
"self": "Tên miền không gian làm việc",
@@ -2128,9 +2132,7 @@
"only-for-cluster": "Chỉ khả dụng cho kết nối cụm"
},
"result-limit": {
- "self": "Giới hạn kết quả",
- "n-rows": "{n} dòng",
- "rows": "dòng"
+ "self": "Giới hạn kết quả"
},
"n-per-page": "{n} / trang",
"add-a-new-instance": "Thêm một phiên bản mới",
@@ -2426,7 +2428,8 @@
"name": "Cấp độ",
"error": "Lỗi",
"warning": "Cảnh báo"
- }
+ },
+ "tooltip-for-resource": "Bạn cũng có thể cấu hình ở cấp độ {scope}. Bytebase sẽ ưu tiên cấu hình ở cấp độ môi trường."
},
"audit-log": {
"export-finished": "Xuất hoàn tất",
diff --git a/frontend/src/locales/zh-CN.json b/frontend/src/locales/zh-CN.json
index 606a3051e9..6e4fff8fec 100644
--- a/frontend/src/locales/zh-CN.json
+++ b/frontend/src/locales/zh-CN.json
@@ -645,7 +645,11 @@
"self": "最大查询时间",
"description": "SQL 编辑器中允许运行查询的最长时间。"
},
- "seconds": "秒"
+ "seconds": "秒",
+ "project-scope": "项目",
+ "workspace-scope": "工作区",
+ "environment-scope": "环境",
+ "tooltip": "也可在 {scope} 级别进行配置。Bytebase 将应用最严格的值。"
},
"domain-restriction": {
"self": "工作空间域名",
@@ -2128,9 +2132,7 @@
"only-for-cluster": "仅适用于集群连接"
},
"result-limit": {
- "self": "结果限制",
- "n-rows": "{n} 行",
- "rows": "行"
+ "self": "结果限制"
},
"n-per-page": "{n} / 页",
"add-a-new-instance": "添加实例",
@@ -2426,7 +2428,8 @@
"name": "级别",
"error": "错误",
"warning": "警告"
- }
+ },
+ "tooltip-for-resource": "也可在 {scope} 级别进行配置。Bytebase 将优先考虑环境级别的配置。"
},
"audit-log": {
"export-finished": "导出完成",
diff --git a/frontend/src/store/modules/v1/policy.ts b/frontend/src/store/modules/v1/policy.ts
index b43e9abde6..767567b9dc 100644
--- a/frontend/src/store/modules/v1/policy.ts
+++ b/frontend/src/store/modules/v1/policy.ts
@@ -1,4 +1,5 @@
import { create } from "@bufbuild/protobuf";
+import { DurationSchema } from "@bufbuild/protobuf/wkt";
import { Code, ConnectError, createContextValues } from "@connectrpc/connect";
import { defineStore } from "pinia";
import { computed, reactive, ref, unref, watchEffect } from "vue";
@@ -7,7 +8,10 @@ import { silentContextKey } from "@/grpcweb/context-key";
import { policyNamePrefix } from "@/store/modules/v1/common";
import type { MaybeRef } from "@/types";
import { UNKNOWN_USER_NAME } from "@/types";
-import type { Policy } from "@/types/proto-es/v1/org_policy_service_pb";
+import type {
+ Policy,
+ QueryDataPolicy,
+} from "@/types/proto-es/v1/org_policy_service_pb";
import {
DeletePolicyRequestSchema,
GetPolicyRequestSchema,
@@ -26,6 +30,8 @@ interface PolicyState {
policyMapByName: Map<string, Policy>;
}
+export const DEFAULT_MAX_RESULT_SIZE_IN_MB = 100;
+
const replacePolicyTypeNameToLowerCase = (name: string) => {
const pattern = /(^|\/)policies\/([^/]+)($|\/)/;
const replaced = name.replace(
@@ -60,22 +66,75 @@ export const usePolicyV1Store = defineStore("policy_v1", () => {
const policyList = computed(() => Array.from(state.policyMapByName.values()));
- const maximumResultRows = computed(() => {
- const queryDataPolicy = getPolicyByParentAndType({
- parentPath: "",
+ const getQueryDataPolicyByParent = (parent: string): QueryDataPolicy => {
+ const policy = getPolicyByParentAndType({
+ parentPath: parent,
policyType: PolicyType.DATA_QUERY,
});
+ return policy?.policy?.case === "queryDataPolicy"
+ ? policy.policy.value
+ : create(QueryDataPolicySchema, {
+ maximumResultSize: BigInt(
+ DEFAULT_MAX_RESULT_SIZE_IN_MB * 1024 * 1024
+ ),
+ maximumResultRows: -1,
+ timeout: create(DurationSchema, {
+ seconds: BigInt(0),
+ }),
+ });
+ };
- const vaule =
- queryDataPolicy?.policy?.case === "queryDataPolicy"
- ? queryDataPolicy.policy.value
- : create(QueryDataPolicySchema);
+ const formatQueryDataPolicy = (policy: QueryDataPolicy) => {
+ let maximumResultSize = Number(policy.maximumResultSize);
+ let maximumResultRows = policy.maximumResultRows;
+ let queryTimeoutInSeconds = Number(policy.timeout?.seconds ?? 0);
- if (vaule.maximumResultRows <= 0) {
- return Number.MAX_VALUE;
+ if (maximumResultSize <= 0) {
+ maximumResultSize = DEFAULT_MAX_RESULT_SIZE_IN_MB * 1024 * 1024;
}
- return vaule.maximumResultRows;
- });
+ if (maximumResultRows <= 0) {
+ maximumResultRows = Number.MAX_VALUE;
+ }
+ if (queryTimeoutInSeconds <= 0) {
+ queryTimeoutInSeconds = Number.MAX_VALUE;
+ }
+
+ return {
+ disableCopyData: policy.disableCopyData,
+ disableExport: policy.disableExport,
+ maximumResultSize,
+ maximumResultRows,
+ queryTimeoutInSeconds,
+ };
+ };
+
+ const getEffectiveQueryDataPolicyForProject = (project: string) => {
+ const workspacePolicy = formatQueryDataPolicy(
+ getQueryDataPolicyByParent("")
+ );
+ const projectPolicy = formatQueryDataPolicy(
+ getQueryDataPolicyByParent(project)
+ );
+
+ return {
+ disableCopyData:
+ projectPolicy.disableCopyData || workspacePolicy.disableCopyData,
+ disableExport:
+ projectPolicy.disableExport || workspacePolicy.disableExport,
+ maximumResultRows: Math.min(
+ projectPolicy.maximumResultRows,
+ workspacePolicy.maximumResultRows
+ ),
+ maximumResultSize: Math.min(
+ projectPolicy.maximumResultSize,
+ workspacePolicy.maximumResultSize
+ ),
+ queryTimeoutInSeconds: Math.min(
+ projectPolicy.queryTimeoutInSeconds,
+ workspacePolicy.queryTimeoutInSeconds
+ ),
+ };
+ };
const fetchPolicies = async ({
resourceType,
@@ -219,7 +278,6 @@ export const usePolicyV1Store = defineStore("policy_v1", () => {
return {
policyList,
- maximumResultRows,
fetchPolicies,
getPolicies,
getOrFetchPolicyByParentAndType,
@@ -228,6 +286,8 @@ export const usePolicyV1Store = defineStore("policy_v1", () => {
getPolicyByName,
upsertPolicy,
deletePolicy,
+ getQueryDataPolicyByParent,
+ getEffectiveQueryDataPolicyForProject,
};
});
diff --git a/frontend/src/views/sql-editor/EditorCommon/QueryContextSettingPopover.vue b/frontend/src/views/sql-editor/EditorCommon/QueryContextSettingPopover.vue
index ab47e3840f..e21917da0d 100644
--- a/frontend/src/views/sql-editor/EditorCommon/QueryContextSettingPopover.vue
+++ b/frontend/src/views/sql-editor/EditorCommon/QueryContextSettingPopover.vue
@@ -85,29 +85,11 @@
{{ $t("sql-editor.redis-command.only-for-cluster") }}
</NTooltip>
<div class="border-t pt-1">
- <ResultLimitSelect
- placement="right-start"
- trigger="hover"
- :maximum="policyStore.maximumResultRows"
- >
- <template
- #default="{ resultRowsLimit }: { resultRowsLimit: number }"
- >
- <NButton
- icon-placement="right"
- quaternary
- style="justify-content: start; --n-padding: 0 8px; width: 100%"
- >
- {{ $t("sql-editor.result-limit.self") }}
- {{
- $t("sql-editor.result-limit.n-rows", { n: resultRowsLimit })
- }}
- <template #icon>
- <ChevronRight />
- </template>
- </NButton>
- </template>
- </ResultLimitSelect>
+ <MaxRowCountSelect
+ v-model:value="resultRowsLimit"
+ :quaternary="true"
+ :maximum-export-count="maximumResultRows"
+ />
</div>
</div>
</template>
@@ -116,11 +98,12 @@
<script lang="ts" setup>
import { orderBy } from "lodash-es";
-import { ChevronDown, ChevronRight } from "lucide-vue-next";
+import { ChevronDown } from "lucide-vue-next";
import { NButton, NPopover, NRadio, NRadioGroup, NTooltip } from "naive-ui";
import { storeToRefs } from "pinia";
import { computed, watch, watchEffect } from "vue";
import { useI18n } from "vue-i18n";
+import MaxRowCountSelect from "@/components/GrantRequestPanel/MaxRowCountSelect.vue";
import {
useConnectionOfCurrentSQLEditorTab,
usePolicyV1Store,
@@ -144,7 +127,6 @@ import {
getValidDataSourceByPolicy,
readableDataSourceType,
} from "@/utils";
-import ResultLimitSelect from "./ResultLimitSelect.vue";
defineProps<{
disabled?: boolean;
@@ -155,10 +137,15 @@ const tabStore = useSQLEditorTabStore();
const { connection, database } = useConnectionOfCurrentSQLEditorTab();
const policyStore = usePolicyV1Store();
-const { redisCommandOption, resultRowsLimit } = storeToRefs(
+const { redisCommandOption, resultRowsLimit, project } = storeToRefs(
useSQLEditorStore()
);
+const maximumResultRows = computed(() => {
+ return policyStore.getEffectiveQueryDataPolicyForProject(project.value)
+ .maximumResultRows;
+});
+
const show = computed(() => {
return tabStore.currentTab?.mode !== "ADMIN";
});
@@ -276,8 +263,8 @@ watch(
);
watchEffect(() => {
- if (resultRowsLimit.value > policyStore.maximumResultRows) {
- resultRowsLimit.value = policyStore.maximumResultRows;
+ if (resultRowsLimit.value > maximumResultRows.value) {
+ resultRowsLimit.value = maximumResultRows.value;
}
});
</script>
diff --git a/frontend/src/views/sql-editor/EditorCommon/ResultLimitSelect.vue b/frontend/src/views/sql-editor/EditorCommon/ResultLimitSelect.vue
deleted file mode 100644
index adc3b73c93..0000000000
--- a/frontend/src/views/sql-editor/EditorCommon/ResultLimitSelect.vue
+++ /dev/null
@@ -1,60 +0,0 @@
-<template>
- <NPopselect
- v-model:value="resultRowsLimit"
- :options="options"
- trigger="click"
- placement="bottom-start"
- scrollable
- >
- <slot name="default" :result-rows-limit="resultRowsLimit">
- <NButton size="small">
- {{ $t("sql-editor.result-limit.n-rows", { n: resultRowsLimit }) }}
- </NButton>
- </slot>
- <template #action>
- <div class="flex items-center justify-between gap-1">
- <NInputNumber
- v-model:value="resultRowsLimit"
- :show-button="false"
- :min="0"
- :max="rowCountOptions[rowCountOptions.length - 1]"
- style="width: 5rem"
- size="small"
- />
- <span>{{ $t("sql-editor.result-limit.rows") }}</span>
- </div>
- </template>
- </NPopselect>
-</template>
-
-<script setup lang="ts">
-import { NButton, NInputNumber, NPopselect, type SelectOption } from "naive-ui";
-import { storeToRefs } from "pinia";
-import { computed } from "vue";
-import { useI18n } from "vue-i18n";
-import { useSQLEditorStore } from "@/store";
-
-const props = defineProps<{
- maximum: number;
-}>();
-
-const { t } = useI18n();
-const { resultRowsLimit } = storeToRefs(useSQLEditorStore());
-
-const rowCountOptions = computed(() => {
- const list = [100, 500, 1000, 5000, 10000, 100000].filter(
- (num) => num <= props.maximum
- );
- if (props.maximum !== Number.MAX_VALUE && !list.includes(props.maximum)) {
- list.push(props.maximum);
- }
- return list;
-});
-
-const options = computed((): SelectOption[] => {
- return rowCountOptions.value.map((n) => ({
- label: t("sql-editor.result-limit.n-rows", { n }),
- value: n,
- }));
-});
-</script>
diff --git a/frontend/src/views/sql-editor/EditorCommon/ResultView/ResultViewV1.vue b/frontend/src/views/sql-editor/EditorCommon/ResultView/ResultViewV1.vue
index cbd9c5639c..dc95ed841d 100644
--- a/frontend/src/views/sql-editor/EditorCommon/ResultView/ResultViewV1.vue
+++ b/frontend/src/views/sql-editor/EditorCommon/ResultView/ResultViewV1.vue
@@ -26,7 +26,8 @@
:database="database"
:result="resultSet.results[0]"
:set-index="0"
- :show-export="!disableExport"
+ :show-export="!effectiveQueryDataPolicy.disableExport"
+ :maximum-export-count="effectiveQueryDataPolicy.maximumResultRows"
@export="handleExportBtnClick"
/>
</template>
@@ -77,11 +78,12 @@
:database="database"
:result="result"
:set-index="i"
- :show-export="!enableExportData"
+ :show-export="false"
+ :maximum-export-count="effectiveQueryDataPolicy.maximumResultRows"
@export="handleExportBtnClick"
/>
</NTabPane>
- <template v-if="enableExportData" #suffix>
+ <template v-if="!effectiveQueryDataPolicy.disableExport" #suffix>
<div class="mb-1">
<DataExportButton
size="small"
@@ -94,6 +96,7 @@
]"
:view-mode="'DRAWER'"
:support-password="true"
+ :maximum-export-count="effectiveQueryDataPolicy.maximumResultRows"
@export="
($event) =>
handleExportBtnClick({
@@ -170,6 +173,7 @@ import {
NTabs,
NTooltip,
} from "naive-ui";
+import { storeToRefs } from "pinia";
import { computed, ref, toRef } from "vue";
import { useI18n } from "vue-i18n";
import { darkThemeOverrides } from "@/../naive-ui.config";
@@ -197,11 +201,6 @@ import type {
SQLResultSetV1,
} from "@/types";
import { ExportFormat } from "@/types/proto-es/v1/common_pb";
-import {
- PolicyType,
- type QueryDataPolicy,
- QueryDataPolicySchema,
-} from "@/types/proto-es/v1/org_policy_service_pb";
import { ExportRequestSchema } from "@/types/proto-es/v1/sql_service_pb";
import { hasWorkspacePermissionV2 } from "@/utils";
import type { SQLResultViewContext } from "./context";
@@ -241,24 +240,10 @@ 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 { project } = storeToRefs(useSQLEditorStore());
-const disableExport = computed(
- () => getQueryDataPolicyByParent("").disableExport
-);
-
-const enableExportData = computed(() => {
- return !disableExport.value;
+const effectiveQueryDataPolicy = computed(() => {
+ return policyStore.getEffectiveQueryDataPolicyForProject(project.value);
});
const keyword = ref("");
@@ -332,7 +317,10 @@ const disallowCopyingData = computed(() => {
let environment = instance.value.environment;
if (props.database) {
- if (getQueryDataPolicyByParent(props.database?.project).disableCopyData) {
+ if (
+ policyStore.getQueryDataPolicyByParent(props.database.project)
+ .disableCopyData
+ ) {
return true;
}
// If the database is provided, use its effective environment.
@@ -341,7 +329,7 @@ const disallowCopyingData = computed(() => {
// Check if the environment has a policy that disables copying data.
if (environment) {
- if (getQueryDataPolicyByParent(environment).disableCopyData) {
+ if (policyStore.getQueryDataPolicyByParent(environment).disableCopyData) {
return true;
}
}
@@ -378,7 +366,7 @@ const handleExportBtnClick = async ({
resolve: (content: DownloadContent[]) => void;
}) => {
const admin = tabStore.currentTab?.mode === "ADMIN";
- const limit = options.limit ?? (admin ? 0 : editorStore.resultRowsLimit);
+ const limit = options.limit;
try {
const content = await useSQLStore().exportData(
diff --git a/frontend/src/views/sql-editor/EditorCommon/ResultView/SingleResultViewV1.vue b/frontend/src/views/sql-editor/EditorCommon/ResultView/SingleResultViewV1.vue
index 19a7925eb6..287cabfeb6 100644
--- a/frontend/src/views/sql-editor/EditorCommon/ResultView/SingleResultViewV1.vue
+++ b/frontend/src/views/sql-editor/EditorCommon/ResultView/SingleResultViewV1.vue
@@ -99,6 +99,7 @@
]"
:view-mode="'DRAWER'"
:support-password="true"
+ :maximum-export-count="maximumExportCount"
@export="
($event) =>
$emit('export', {
@@ -262,6 +263,7 @@ const props = defineProps<{
result: QueryResult;
setIndex: number;
showExport: boolean;
+ maximumExportCount?: number;
}>();
defineEmits<{
diff --git a/frontend/src/views/sql-editor/EditorPanel/ResultPanel/BatchQuerySelect.vue b/frontend/src/views/sql-editor/EditorPanel/ResultPanel/BatchQuerySelect.vue
index fb931a3fe4..fcb90eae58 100644
--- a/frontend/src/views/sql-editor/EditorPanel/ResultPanel/BatchQuerySelect.vue
+++ b/frontend/src/views/sql-editor/EditorPanel/ResultPanel/BatchQuerySelect.vue
@@ -36,6 +36,7 @@
:tooltip="$t('sql-editor.batch-export.tooltip', { max: MAX_EXPORT })"
:validate="validateExport"
:support-password="true"
+ :maximum-export-count="effectiveQueryDataPolicy.maximumResultRows"
@export="handleExportBtnClick"
>
<template #form>
@@ -120,6 +121,8 @@ import { t } from "@/plugins/i18n";
import {
pushNotification,
useDatabaseV1Store,
+ usePolicyV1Store,
+ useSQLEditorStore,
useSQLEditorTabStore,
useSQLStore,
} from "@/store";
@@ -148,6 +151,12 @@ const { currentTab: tab } = storeToRefs(tabStore);
const databaseStore = useDatabaseV1Store();
const sqlStore = useSQLStore();
const showEmpty = ref<boolean>(true);
+const policyStore = usePolicyV1Store();
+const { project } = storeToRefs(useSQLEditorStore());
+
+const effectiveQueryDataPolicy = computed(() => {
+ return policyStore.getEffectiveQueryDataPolicyForProject(project.value);
+});
const selectedDatabaseNameList = ref<string[]>([]);