Skip to content

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

feat: add AIP-132 order_by to ListSavedQueries and a recency index (#21203)

Danny Xue84f6e4c91b1
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yaml
index 5c0be31dc3..ab519cc857 100644
--- a/backend/api/mcp/gen/openapi.yaml
+++ b/backend/api/mcp/gen/openapi.yaml
@@ -4277,6 +4277,7 @@ paths:
summary: ListQueryHistories
description: |-
ListQueryHistories lists query histories of all users in a project.
+ Results are ordered by create time descending (newest first).
Permissions required: bb.queryHistories.list
operationId: bytebase.v1.QueryHistoryService.ListQueryHistories
parameters:
@@ -5972,6 +5973,7 @@ paths:
List saved queries for auditing. The permission alone grants reading
every matched saved query with full content, private ones included;
bindings are ignored. Use parent "projects/-" for all projects.
+ Results default to title ascending; see `order_by`.
Permissions required: bb.savedQueries.list on the project, or on the
workspace when the parent is "projects/-"
operationId: bytebase.v1.SavedQueryService.ListSavedQueries
@@ -14567,6 +14569,17 @@ components:
description: |-
A page token from a previous ListSavedQueries call. Keep every other
parameter the same as the call that returned it.
+ orderBy:
+ type: string
+ title: order_by
+ description: |-
+ Sort the results, per https://google.aip.dev/132#ordering. Supported
+ fields: `update_time`, `create_time`, `title`; append " desc" for
+ descending, e.g. "update_time desc" for most recently modified first.
+ A modification is a title, content, database, or folder write; sharing
+ and stars do not count, and a never-modified saved query counts its
+ create time. Empty means `title` ascending. `resource_id` is always
+ appended as a final tiebreak so pages stay stable.
title: ListSavedQueriesRequest
additionalProperties: false
bytebase.v1.ListSavedQueriesResponse:
diff --git a/backend/api/v1/saved_query_service.go b/backend/api/v1/saved_query_service.go
index 73324cefef..4d8d2e3d21 100644
--- a/backend/api/v1/saved_query_service.go
+++ b/backend/api/v1/saved_query_service.go
@@ -188,6 +188,10 @@ func (s *SavedQueryService) ListSavedQueries(
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
+ orderByKeys, err := store.GetSavedQueryOrders(request.OrderBy)
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, err)
+ }
savedQueryList, err := s.store.ListSavedQueries(ctx, &store.FindSavedQueryMessage{
ProjectIDs: projectIDs,
@@ -200,7 +204,8 @@ func (s *SavedQueryService) ListSavedQueries(
// offers GetSavedQuery for the rest, but a caller holding only
// bb.savedQueries.list cannot Get another creator's row, so a
// truncated statement here would have no way back to the full one.
- LoadFull: true,
+ LoadFull: true,
+ OrderByKeys: orderByKeys,
})
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list saved queries: %v", err))
diff --git a/backend/generated-go/v1/query_history_service_grpc.pb.go b/backend/generated-go/v1/query_history_service_grpc.pb.go
index 135617cc55..c5abf96e5a 100644
--- a/backend/generated-go/v1/query_history_service_grpc.pb.go
+++ b/backend/generated-go/v1/query_history_service_grpc.pb.go
@@ -34,6 +34,7 @@ type QueryHistoryServiceClient interface {
// Permissions required: None (only returns caller's own query histories)
SearchQueryHistories(ctx context.Context, in *SearchQueryHistoriesRequest, opts ...grpc.CallOption) (*SearchQueryHistoriesResponse, error)
// ListQueryHistories lists query histories of all users in a project.
+ // Results are ordered by create time descending (newest first).
// Permissions required: bb.queryHistories.list
ListQueryHistories(ctx context.Context, in *ListQueryHistoriesRequest, opts ...grpc.CallOption) (*ListQueryHistoriesResponse, error)
// GetQueryHistory gets a single query history for the caller.
@@ -89,6 +90,7 @@ type QueryHistoryServiceServer interface {
// Permissions required: None (only returns caller's own query histories)
SearchQueryHistories(context.Context, *SearchQueryHistoriesRequest) (*SearchQueryHistoriesResponse, error)
// ListQueryHistories lists query histories of all users in a project.
+ // Results are ordered by create time descending (newest first).
// Permissions required: bb.queryHistories.list
ListQueryHistories(context.Context, *ListQueryHistoriesRequest) (*ListQueryHistoriesResponse, error)
// GetQueryHistory gets a single query history for the caller.
diff --git a/backend/generated-go/v1/saved_query_service.pb.go b/backend/generated-go/v1/saved_query_service.pb.go
index 1edaad7e75..d2c6a3952d 100644
--- a/backend/generated-go/v1/saved_query_service.pb.go
+++ b/backend/generated-go/v1/saved_query_service.pb.go
@@ -199,7 +199,15 @@ type ListSavedQueriesRequest struct {
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token from a previous ListSavedQueries call. Keep every other
// parameter the same as the call that returned it.
- PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
+ PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
+ // Sort the results, per https://google.aip.dev/132#ordering. Supported
+ // fields: `update_time`, `create_time`, `title`; append " desc" for
+ // descending, e.g. "update_time desc" for most recently modified first.
+ // A modification is a title, content, database, or folder write; sharing
+ // and stars do not count, and a never-modified saved query counts its
+ // create time. Empty means `title` ascending. `resource_id` is always
+ // appended as a final tiebreak so pages stay stable.
+ OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
@@ -262,6 +270,13 @@ func (x *ListSavedQueriesRequest) GetPageToken() string {
return ""
}
+func (x *ListSavedQueriesRequest) GetOrderBy() string {
+ if x != nil {
+ return x.OrderBy
+ }
+ return ""
+}
+
type ListSavedQueriesResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
SavedQueries []*SavedQuery `protobuf:"bytes,1,rep,name=saved_queries,json=savedQueries,proto3" json:"saved_queries,omitempty"`
@@ -1201,14 +1216,15 @@ const file_v1_saved_query_service_proto_rawDesc = "" +
"savedQuery\"K\n" +
"\x14GetSavedQueryRequest\x123\n" +
"\x04name\x18\x01 \x01(\tB\x1f\xe0A\x02\xfaA\x19\n" +
- "\x17bytebase.com/SavedQueryR\x04name\"\xa3\x01\n" +
+ "\x17bytebase.com/SavedQueryR\x04name\"\xbe\x01\n" +
"\x17ListSavedQueriesRequest\x124\n" +
"\x06parent\x18\x01 \x01(\tB\x1c\xe0A\x02\xfaA\x16\n" +
"\x14bytebase.com/ProjectR\x06parent\x12\x16\n" +
"\x06filter\x18\x02 \x01(\tR\x06filter\x12\x1b\n" +
"\tpage_size\x18\x03 \x01(\x05R\bpageSize\x12\x1d\n" +
"\n" +
- "page_token\x18\x04 \x01(\tR\tpageToken\"\x80\x01\n" +
+ "page_token\x18\x04 \x01(\tR\tpageToken\x12\x19\n" +
+ "\border_by\x18\x05 \x01(\tR\aorderBy\"\x80\x01\n" +
"\x18ListSavedQueriesResponse\x12<\n" +
"\rsaved_queries\x18\x01 \x03(\v2\x17.bytebase.v1.SavedQueryR\fsavedQueries\x12&\n" +
"\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken\"n\n" +
diff --git a/backend/generated-go/v1/saved_query_service_equal.pb.go b/backend/generated-go/v1/saved_query_service_equal.pb.go
index 6f03fc0faa..8b0c6944e3 100644
--- a/backend/generated-go/v1/saved_query_service_equal.pb.go
+++ b/backend/generated-go/v1/saved_query_service_equal.pb.go
@@ -56,6 +56,9 @@ func (x *ListSavedQueriesRequest) Equal(y *ListSavedQueriesRequest) bool {
if x.PageToken != y.PageToken {
return false
}
+ if x.OrderBy != y.OrderBy {
+ return false
+ }
return true
}
diff --git a/backend/generated-go/v1/saved_query_service_grpc.pb.go b/backend/generated-go/v1/saved_query_service_grpc.pb.go
index dc9f385d23..eebaa5416b 100644
--- a/backend/generated-go/v1/saved_query_service_grpc.pb.go
+++ b/backend/generated-go/v1/saved_query_service_grpc.pb.go
@@ -62,6 +62,7 @@ type SavedQueryServiceClient interface {
// List saved queries for auditing. The permission alone grants reading
// every matched saved query with full content, private ones included;
// bindings are ignored. Use parent "projects/-" for all projects.
+ // Results default to title ascending; see `order_by`.
// Permissions required: bb.savedQueries.list on the project, or on the
// workspace when the parent is "projects/-"
ListSavedQueries(ctx context.Context, in *ListSavedQueriesRequest, opts ...grpc.CallOption) (*ListSavedQueriesResponse, error)
@@ -254,6 +255,7 @@ type SavedQueryServiceServer interface {
// List saved queries for auditing. The permission alone grants reading
// every matched saved query with full content, private ones included;
// bindings are ignored. Use parent "projects/-" for all projects.
+ // Results default to title ascending; see `order_by`.
// Permissions required: bb.savedQueries.list on the project, or on the
// workspace when the parent is "projects/-"
ListSavedQueries(context.Context, *ListSavedQueriesRequest) (*ListSavedQueriesResponse, error)
diff --git a/backend/generated-go/v1/v1connect/query_history_service.connect.go b/backend/generated-go/v1/v1connect/query_history_service.connect.go
index 017e8dd25e..3bb98ed2bb 100644
--- a/backend/generated-go/v1/v1connect/query_history_service.connect.go
+++ b/backend/generated-go/v1/v1connect/query_history_service.connect.go
@@ -50,6 +50,7 @@ type QueryHistoryServiceClient interface {
// Permissions required: None (only returns caller's own query histories)
SearchQueryHistories(context.Context, *connect.Request[v1.SearchQueryHistoriesRequest]) (*connect.Response[v1.SearchQueryHistoriesResponse], error)
// ListQueryHistories lists query histories of all users in a project.
+ // Results are ordered by create time descending (newest first).
// Permissions required: bb.queryHistories.list
ListQueryHistories(context.Context, *connect.Request[v1.ListQueryHistoriesRequest]) (*connect.Response[v1.ListQueryHistoriesResponse], error)
// GetQueryHistory gets a single query history for the caller.
@@ -117,6 +118,7 @@ type QueryHistoryServiceHandler interface {
// Permissions required: None (only returns caller's own query histories)
SearchQueryHistories(context.Context, *connect.Request[v1.SearchQueryHistoriesRequest]) (*connect.Response[v1.SearchQueryHistoriesResponse], error)
// ListQueryHistories lists query histories of all users in a project.
+ // Results are ordered by create time descending (newest first).
// Permissions required: bb.queryHistories.list
ListQueryHistories(context.Context, *connect.Request[v1.ListQueryHistoriesRequest]) (*connect.Response[v1.ListQueryHistoriesResponse], error)
// GetQueryHistory gets a single query history for the caller.
diff --git a/backend/generated-go/v1/v1connect/saved_query_service.connect.go b/backend/generated-go/v1/v1connect/saved_query_service.connect.go
index 5f2053ef97..71aae86332 100644
--- a/backend/generated-go/v1/v1connect/saved_query_service.connect.go
+++ b/backend/generated-go/v1/v1connect/saved_query_service.connect.go
@@ -82,6 +82,7 @@ type SavedQueryServiceClient interface {
// List saved queries for auditing. The permission alone grants reading
// every matched saved query with full content, private ones included;
// bindings are ignored. Use parent "projects/-" for all projects.
+ // Results default to title ascending; see `order_by`.
// Permissions required: bb.savedQueries.list on the project, or on the
// workspace when the parent is "projects/-"
ListSavedQueries(context.Context, *connect.Request[v1.ListSavedQueriesRequest]) (*connect.Response[v1.ListSavedQueriesResponse], error)
@@ -290,6 +291,7 @@ type SavedQueryServiceHandler interface {
// List saved queries for auditing. The permission alone grants reading
// every matched saved query with full content, private ones included;
// bindings are ignored. Use parent "projects/-" for all projects.
+ // Results default to title ascending; see `order_by`.
// Permissions required: bb.savedQueries.list on the project, or on the
// workspace when the parent is "projects/-"
ListSavedQueries(context.Context, *connect.Request[v1.ListSavedQueriesRequest]) (*connect.Response[v1.ListSavedQueriesResponse], error)
diff --git a/backend/migrator/migration/3.22/0010##saved_query_updated_at_index.sql b/backend/migrator/migration/3.22/0010##saved_query_updated_at_index.sql
new file mode 100644
index 0000000000..9e67ecbabb
--- /dev/null
+++ b/backend/migrator/migration/3.22/0010##saved_query_updated_at_index.sql
@@ -0,0 +1,10 @@
+-- The governance ListSavedQueries takes an AIP-132 order_by, and its primary
+-- consumer is the cross-project per-user recency pull: creator filter +
+-- "update_time desc". This index serves that filter and the (updated_at
+-- DESC, resource_id DESC) order in one scan: no sort, and LIMIT stops early.
+CREATE INDEX idx_saved_query_creator_updated_at_resource_id ON saved_query(creator, updated_at DESC, resource_id DESC);
+
+-- The new index covers every creator-led scan (creator, project) served —
+-- including the purge subqueries, which read columns outside it anyway — so
+-- drop it rather than write three creator-led btrees on every update.
+DROP INDEX IF EXISTS idx_saved_query_creator_project;
diff --git a/backend/migrator/migration/LATEST.sql b/backend/migrator/migration/LATEST.sql
index 4627bcdf6b..c71186fd0e 100644
--- a/backend/migrator/migration/LATEST.sql
+++ b/backend/migrator/migration/LATEST.sql
@@ -386,7 +386,11 @@ CREATE TABLE saved_query (
-- as index-only scans, and the project prefix still answers a project lookup
-- on its own.
CREATE INDEX idx_saved_query_project_creator_folder ON saved_query(project, creator, folder);
-CREATE INDEX idx_saved_query_creator_project ON saved_query(creator, project);
+
+-- The governance ListSavedQueries recency pull (creator filter +
+-- order_by "update_time desc") reads this index in order with no sort; it
+-- also covers every other creator-led scan via its prefix.
+CREATE INDEX idx_saved_query_creator_updated_at_resource_id ON saved_query(creator, updated_at DESC, resource_id DESC);
-- "Shared with me" probes bindings once per principal in the caller's set and
-- BitmapOrs the results. jsonb_path_ops is smaller and faster than the default
diff --git a/backend/migrator/migrator_test.go b/backend/migrator/migrator_test.go
index 66bc212075..41aa741303 100644
--- a/backend/migrator/migrator_test.go
+++ b/backend/migrator/migrator_test.go
@@ -21,8 +21,8 @@ import (
func TestLatestVersion(t *testing.T) {
files, err := getSortedVersionedFiles()
require.NoError(t, err)
- require.Equal(t, semver.MustParse("3.22.9"), *files[len(files)-1].version)
- require.Equal(t, "migration/3.22/0009##split_saved_query_manage.sql", files[len(files)-1].path)
+ require.Equal(t, semver.MustParse("3.22.10"), *files[len(files)-1].version)
+ require.Equal(t, "migration/3.22/0010##saved_query_updated_at_index.sql", files[len(files)-1].path)
}
func TestVersionUnique(t *testing.T) {
diff --git a/backend/store/common.go b/backend/store/common.go
index a6d1ccbbe4..9163e3ce5b 100644
--- a/backend/store/common.go
+++ b/backend/store/common.go
@@ -2,6 +2,7 @@ package store
import (
"regexp"
+ "strings"
"github.com/pkg/errors"
)
@@ -35,6 +36,46 @@ type OrderByKey struct {
SortOrder SortOrder
}
+// getOrderByKeys parses an AIP-132 order_by string against a whitelist
+// mapping API field names to SQL columns. Strict where parseOrderBy is not:
+// every comma-separated entry must be a whitelisted field with an optional
+// "asc"/"desc" suffix, and a repeated field is rejected — malformed input
+// errors instead of being silently reinterpreted.
+func getOrderByKeys(orderBy string, columns map[string]string) ([]*OrderByKey, error) {
+ if orderBy == "" {
+ return nil, nil
+ }
+
+ var result []*OrderByKey
+ seen := make(map[string]bool)
+ for entry := range strings.SplitSeq(orderBy, ",") {
+ parts := strings.Fields(entry)
+ if len(parts) == 0 || len(parts) > 2 {
+ return nil, errors.Errorf("invalid order_by entry %q", strings.TrimSpace(entry))
+ }
+ column, ok := columns[parts[0]]
+ if !ok {
+ return nil, errors.Errorf("unsupported order field %q", parts[0])
+ }
+ if seen[parts[0]] {
+ return nil, errors.Errorf("duplicate order field %q", parts[0])
+ }
+ seen[parts[0]] = true
+ sortOrder := ASC
+ if len(parts) == 2 {
+ switch parts[1] {
+ case "asc":
+ case "desc":
+ sortOrder = DESC
+ default:
+ return nil, errors.Errorf("invalid order direction %q, expect asc or desc", parts[1])
+ }
+ }
+ result = append(result, &OrderByKey{Key: column, SortOrder: sortOrder})
+ }
+ return result, nil
+}
+
func parseOrderBy(orderBy string) ([]*OrderByKey, error) {
if orderBy == "" {
return nil, nil
diff --git a/backend/store/query_history.go b/backend/store/query_history.go
index 9b8afff146..a2497b08f4 100644
--- a/backend/store/query_history.go
+++ b/backend/store/query_history.go
@@ -158,7 +158,8 @@ func (s *Store) ListQueryHistories(ctx context.Context, find *FindQueryHistoryMe
q.And("query_history.type = ?", *v)
}
- q.Space("ORDER BY created_at DESC")
+ // resource_id breaks created_at ties so offset pages stay stable.
+ q.Space("ORDER BY created_at DESC, resource_id DESC")
if v := find.Limit; v != nil {
q.Space("LIMIT ?", *v)
}
diff --git a/backend/store/saved_query.go b/backend/store/saved_query.go
index 6f430ea26a..7de1ef31ce 100644
--- a/backend/store/saved_query.go
+++ b/backend/store/saved_query.go
@@ -76,6 +76,9 @@ type FindSavedQueryMessage struct {
// LoadFull is used if we want to load the full sheet.
LoadFull bool
+ // OrderByKeys overrides the default title order.
+ OrderByKeys []*OrderByKey
+
FilterQ *qb.Query
Limit *int
@@ -172,7 +175,21 @@ func (s *Store) ListSavedQueries(ctx context.Context, find *FindSavedQueryMessag
q.And("saved_query.resource_id = ?", *v)
}
- q.Space("ORDER BY saved_query.name, saved_query.resource_id")
+ // Default title order; List overrides via order_by. The resource_id
+ // tiebreak keeps pages stable and follows the last key's direction so
+ // "update_time desc" matches the
+ // (creator, updated_at DESC, resource_id DESC) index exactly.
+ keys := find.OrderByKeys
+ if len(keys) == 0 {
+ keys = []*OrderByKey{{Key: "saved_query.name", SortOrder: ASC}}
+ }
+ orderBy := []string{}
+ for _, v := range keys {
+ orderBy = append(orderBy, fmt.Sprintf("%s %s", v.Key, v.SortOrder.String()))
+ }
+ last := keys[len(keys)-1]
+ orderBy = append(orderBy, fmt.Sprintf("saved_query.resource_id %s", last.SortOrder.String()))
+ q.Space(fmt.Sprintf("ORDER BY %s", strings.Join(orderBy, ", ")))
if v := find.Limit; v != nil {
q.Space("LIMIT ?", *v)
}
@@ -419,7 +436,10 @@ func (s *Store) CreateSavedQuery(ctx context.Context, create *SavedQueryMessage)
// PatchSavedQuery updates a sheet.
func (s *Store) PatchSavedQuery(ctx context.Context, patch *PatchSavedQueryMessage) error {
set := qb.Q()
- set.Comma("updated_at = ?", time.Now())
+ // The DB clock, not the app clock: updated_at is an order_by sort key,
+ // and creation stamps it with DEFAULT now(), so a skewed app server
+ // must not interleave edits out of true sequence.
+ set.Comma("updated_at = now()")
if v := patch.Title; v != nil {
set.Comma("name = ?", *v)
}
@@ -904,6 +924,17 @@ func escapeLikePattern(pattern string) string {
).Replace(pattern)
}
+// GetSavedQueryOrders parses an AIP-132 order_by string into OrderByKey
+// entries for ListSavedQueries. Supported fields: update_time, create_time,
+// title.
+func GetSavedQueryOrders(orderBy string) ([]*OrderByKey, error) {
+ return getOrderByKeys(orderBy, map[string]string{
+ "update_time": "saved_query.updated_at",
+ "create_time": "saved_query.created_at",
+ "title": "saved_query.name",
+ })
+}
+
func GetListSavedQueryFilter(filter string) (*qb.Query, error) {
if filter == "" {
return nil, nil
diff --git a/backend/tests/collision_helper_test.go b/backend/tests/collision_helper_test.go
index 66f8c6ec18..e9b99d7620 100644
--- a/backend/tests/collision_helper_test.go
+++ b/backend/tests/collision_helper_test.go
@@ -190,6 +190,8 @@ func setupCollidingProjects(
}))
a.NoError(err)
+ waitPlanCheckRunSettled(ctx, t, ctl, planB.Msg.Name)
+
f := &collisionFixture{
ProjectA: projectA.Msg,
ProjectB: projectB.Msg,
@@ -258,6 +260,8 @@ func setupCollidingProjectsSeparateInstances(
planB, issueB := createPlanAndIssue(ctx, t, ctl, projectB.Msg, dbB.Msg, "Collision test B")
+ waitPlanCheckRunSettled(ctx, t, ctl, planB.Name)
+
f := &collisionFixture{
ProjectA: projectA.Msg,
ProjectB: projectB.Msg,
@@ -529,6 +533,37 @@ func createPlanIssueRollout(ctx context.Context, t *testing.T, ctl *controller,
return plan, issue, rollout.Msg
}
+// waitPlanCheckRunSettled blocks until the plan's check run leaves the
+// scheduler's hands, so a snapshot of the project is a stable oracle.
+//
+// CreatePlan writes the check run synchronously but the plancheck runner
+// executes it in the background, walking AVAILABLE -> RUNNING -> DONE.
+// Project A settles on its own because the fixture waits out its rollout;
+// project B, whose rollout the caller drives, would otherwise still be
+// mid-flight when a test takes its "before" snapshot. The status then
+// advances during the test and assertProjectUnchanged reads project B's own
+// scheduler as a cross-project write.
+//
+// A plan with no check run is a steady state, not something to wait for.
+func waitPlanCheckRunSettled(ctx context.Context, t *testing.T, ctl *controller, planName string) {
+ t.Helper()
+ a := require.New(t)
+ var last v1pb.PlanCheckRun_Status
+ a.Eventually(func() bool {
+ resp, err := ctl.planServiceClient.GetPlanCheckRun(ctx, connect.NewRequest(&v1pb.GetPlanCheckRunRequest{
+ Name: planName + "/planCheckRun",
+ }))
+ if err != nil {
+ return connect.CodeOf(err) == connect.CodeNotFound
+ }
+ last = resp.Msg.Status
+ return last == v1pb.PlanCheckRun_DONE ||
+ last == v1pb.PlanCheckRun_FAILED ||
+ last == v1pb.PlanCheckRun_CANCELED
+ }, 120*time.Second, 200*time.Millisecond,
+ "plan check run for %s never settled (last status %v)", planName, last)
+}
+
// projectSnapshot captures the state of a project's composite-PK rows as
// observed through the public gRPC API. Each slice's rows are keyed by the
// UID parsed from their resource name.
diff --git a/backend/tests/saved_query_test.go b/backend/tests/saved_query_test.go
index 7204c41867..31a9787d37 100644
--- a/backend/tests/saved_query_test.go
+++ b/backend/tests/saved_query_test.go
@@ -162,7 +162,10 @@ func TestListSavedQueries(t *testing.T) {
a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
}
-func TestSearchSavedQueriesFilterByFolder(t *testing.T) {
+// TestListSavedQueriesOrdering pins the governance List contract: a stable
+// title-ascending default that editing must not reshuffle, and AIP-132
+// order_by for recency pulls.
+func TestListSavedQueriesOrdering(t *testing.T) {
t.Parallel()
a := require.New(t)
ctx := context.Background()
@@ -172,15 +175,105 @@ func TestSearchSavedQueriesFilterByFolder(t *testing.T) {
defer ctl.Close(ctx)
createSavedQuery := func(title string) *v1pb.SavedQuery {
- resp, err := ctl.savedQueryServiceClient.CreateSavedQuery(ctx, connect.NewRequest(&v1pb.CreateSavedQueryRequest{
- Parent: ctl.project.Name,
- SavedQuery: &v1pb.SavedQuery{
- Title: title,
- Content: []byte("SELECT 1;"),
- },
+ return createTitledSavedQuery(ctx, a, ctl, title)
+ }
+
+ // Titles sort against creation and edit order on purpose.
+ first := createSavedQuery("zebra-first")
+ second := createSavedQuery("alpha-second")
+ third := createSavedQuery("middle-third")
+
+ // Editing a row must not move it in the default order; only an explicit
+ // "update_time desc" surfaces it first.
+ _, err = ctl.savedQueryServiceClient.UpdateSavedQuery(ctx, connect.NewRequest(&v1pb.UpdateSavedQueryRequest{
+ SavedQuery: &v1pb.SavedQuery{Name: first.Name, Content: []byte("SELECT 2;")},
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"content"}},
+ }))
+ a.NoError(err)
+
+ filter := `creator == "users/[email protected]"`
+
+ // Default: title ascending, unaffected by the edit.
+ listResp, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: filter,
+ }))
+ a.NoError(err)
+ a.Equal([]string{second.Name, third.Name, first.Name}, savedQueryNames(listResp.Msg.SavedQueries))
+
+ // The recency pull: the edited row leads.
+ recency := []string{first.Name, third.Name, second.Name}
+ byUpdated, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: filter,
+ OrderBy: "update_time desc",
+ }))
+ a.NoError(err)
+ a.Equal(recency, savedQueryNames(byUpdated.Msg.SavedQueries))
+
+ // Pagination follows the requested order: fixed pages, so a token bug
+ // fails an assertion instead of hanging the suite.
+ firstPage, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: filter,
+ OrderBy: "update_time desc",
+ PageSize: 1,
+ }))
+ a.NoError(err)
+ a.Equal(recency[:1], savedQueryNames(firstPage.Msg.SavedQueries))
+ a.NotEmpty(firstPage.Msg.NextPageToken)
+
+ secondPage, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: filter,
+ OrderBy: "update_time desc",
+ PageSize: 1,
+ PageToken: firstPage.Msg.NextPageToken,
+ }))
+ a.NoError(err)
+ a.Equal(recency[1:2], savedQueryNames(secondPage.Msg.SavedQueries))
+
+ // create_time follows creation order regardless of the edit.
+ byCreated, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: filter,
+ OrderBy: "create_time desc",
+ }))
+ a.NoError(err)
+ a.Equal([]string{third.Name, second.Name, first.Name}, savedQueryNames(byCreated.Msg.SavedQueries))
+
+ // The explicit title order goes through the parser, unlike the default.
+ byTitle, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: filter,
+ OrderBy: "title",
+ }))
+ a.NoError(err)
+ a.Equal([]string{second.Name, third.Name, first.Name}, savedQueryNames(byTitle.Msg.SavedQueries))
+
+ // Malformed order_by is rejected, not silently reinterpreted.
+ for _, invalid := range []string{"content desc", "-update_time", "update_time descending", "update_time desc, update_time"} {
+ _, err = ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: filter,
+ OrderBy: invalid,
}))
- a.NoError(err)
- return resp.Msg
+ a.Error(err)
+ a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err), invalid)
+ }
+}
+
+func TestSearchSavedQueriesFilterByFolder(t *testing.T) {
+ t.Parallel()
+ a := require.New(t)
+ ctx := context.Background()
+ ctl := &controller{}
+ ctx, err := ctl.StartServerWithExternalPg(ctx)
+ a.NoError(err)
+ defer ctl.Close(ctx)
+
+ createSavedQuery := func(title string) *v1pb.SavedQuery {
+ return createTitledSavedQuery(ctx, a, ctl, title)
}
setFolder := func(savedQuery *v1pb.SavedQuery, folder string) {
_, err := ctl.savedQueryServiceClient.UpdateSavedQuery(ctx, connect.NewRequest(&v1pb.UpdateSavedQueryRequest{
@@ -265,15 +358,7 @@ func TestSearchSavedQueriesFilterByTitle(t *testing.T) {
defer ctl.Close(ctx)
createSavedQuery := func(title string) *v1pb.SavedQuery {
- resp, err := ctl.savedQueryServiceClient.CreateSavedQuery(ctx, connect.NewRequest(&v1pb.CreateSavedQueryRequest{
- Parent: ctl.project.Name,
- SavedQuery: &v1pb.SavedQuery{
- Title: title,
- Content: []byte("SELECT 1;"),
- },
- }))
- a.NoError(err)
- return resp.Msg
+ return createTitledSavedQuery(ctx, a, ctl, title)
}
matchedSavedQuery := createSavedQuery("Production Payroll Report")
@@ -730,6 +815,20 @@ func TestSearchSavedQueriesRejectsWildcardProject(t *testing.T) {
a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
}
+// createTitledSavedQuery creates a title-only saved query in the default
+// project — the shared fixture the list/search tests build on.
+func createTitledSavedQuery(ctx context.Context, a *require.Assertions, ctl *controller, title string) *v1pb.SavedQuery {
+ resp, err := ctl.savedQueryServiceClient.CreateSavedQuery(ctx, connect.NewRequest(&v1pb.CreateSavedQueryRequest{
+ Parent: ctl.project.Name,
+ SavedQuery: &v1pb.SavedQuery{
+ Title: title,
+ Content: []byte("SELECT 1;"),
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+}
+
func savedQueryNames(savedQueries []*v1pb.SavedQuery) []string {
names := make([]string, 0, len(savedQueries))
for _, savedQuery := range savedQueries {
diff --git a/docs/design/saved-queries-model.md b/docs/design/saved-queries-model.md
index fe922844b4..1ea7545df9 100644
--- a/docs/design/saved-queries-model.md
+++ b/docs/design/saved-queries-model.md
@@ -683,13 +683,18 @@ LIMIT $n OFFSET $k;
Honest per-tab costs (G7):
-- **My** (`creator = me`): the `(project, creator, folder)` and
- `(creator, project)` btrees answer the equality; the title sort is
- uncovered, so each page sorts the matched rows. That set is one person's
- scratchpad in one project — tens to hundreds — so the sort is noise. The
- `(creator, project)` index also serves the auditor's cross-project
- `creator` filter (no binding test needed there), which is bounded and
- cold enough to need no index of its own.
+- **My** (`creator = me`): the `(project, creator, folder)` btree answers
+ the equality; the title sort is uncovered, so each page sorts the
+ matched rows. That set is one person's scratchpad in one project — tens
+ to hundreds — so the sort is noise. The auditor's cross-project
+ `creator` filter (no binding test needed there) outgrew that index when
+ it became a programmatic service-account pull (BYT-10078): it now has
+ `(creator, updated_at DESC, resource_id DESC)`, which serves the filter
+ and the pull's `order_by` "update_time desc" in one scan. The old
+ `(creator, project)` btree is dropped in the same migration: every
+ creator-led scan it served — including the purge subqueries, which read
+ columns outside it anyway — rides the new index's creator prefix, and
+ keeping it would mean three creator-led btrees written on every update.
- **Starred**: my rows in `saved_query_star` via its `principal` btree —
row existence is the star. Fetch the (naturally small) set, join, drop
rows I can no longer read from the view — the star row itself persists,
@@ -708,14 +713,22 @@ carries no cursor field to hold a keyset. Saved queries use the same
mechanism; adopting keyset pagination here would be a platform-wide change,
out of scope for this design. Two properties worth naming:
-- **The sort key is the title** (`saved_query.name`), matching the SQL
+- **Search sorts by title** (`saved_query.name`), matching the SQL
Editor's folder tree rather than a recency feed. This matters more than
it looks: titles change only on explicit create, rename, or delete, so
the row set under a paging caller is nearly static, and the window in
which offset paging can skip or repeat a row is correspondingly narrow.
Ordering by `updated_at` would instead have the 2-second autosave
debounce reshuffling the list continuously — a worse fit for the same
- pagination mechanism.
+ pagination mechanism. `ListSavedQueries` shares the title default — a
+ row must not jump the list because somebody edited it — and carries an
+ AIP-132 `order_by` (BYT-10078: `update_time`, `create_time`, `title`,
+ each ± `desc`; `resource_id` appended as tiebreak in the last key's
+ direction) for pulls that want recency instead. "update_time desc"
+ accepts the churn the title order avoids — a row autosaved mid-pull can
+ skip or repeat across pages, healed by the consumer's next sync. The
+ recency pull's index is costed in the My bullet above; other orders sort
+ per page, fine at per-user volumes.
- **The offset re-scan is real but small**: page *k* walks and discards
*k × page* rows. Scratchpad volumes keep this far from mattering; if a
project's list ever grows enough to feel it, the first fix is an index
diff --git a/frontend/src/types/proto-es/v1/query_history_service_pb.d.ts b/frontend/src/types/proto-es/v1/query_history_service_pb.d.ts
index e7e539d94b..e2d2242268 100644
--- a/frontend/src/types/proto-es/v1/query_history_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/query_history_service_pb.d.ts
@@ -308,6 +308,7 @@ export declare const QueryHistoryService: GenService<{
},
/**
* ListQueryHistories lists query histories of all users in a project.
+ * Results are ordered by create time descending (newest first).
* Permissions required: bb.queryHistories.list
*
* @generated from rpc bytebase.v1.QueryHistoryService.ListQueryHistories
diff --git a/frontend/src/types/proto-es/v1/saved_query_service_pb.d.ts b/frontend/src/types/proto-es/v1/saved_query_service_pb.d.ts
index 89a783b841..91acdd7f67 100644
--- a/frontend/src/types/proto-es/v1/saved_query_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/saved_query_service_pb.d.ts
@@ -95,6 +95,19 @@ export declare type ListSavedQueriesRequest = Message<"bytebase.v1.ListSavedQuer
* @generated from field: string page_token = 4;
*/
pageToken: string;
+
+ /**
+ * Sort the results, per https://google.aip.dev/132#ordering. Supported
+ * fields: `update_time`, `create_time`, `title`; append " desc" for
+ * descending, e.g. "update_time desc" for most recently modified first.
+ * A modification is a title, content, database, or folder write; sharing
+ * and stars do not count, and a never-modified saved query counts its
+ * create time. Empty means `title` ascending. `resource_id` is always
+ * appended as a final tiebreak so pages stay stable.
+ *
+ * @generated from field: string order_by = 5;
+ */
+ orderBy: string;
};
/**
@@ -655,6 +668,7 @@ export declare const SavedQueryService: GenService<{
* List saved queries for auditing. The permission alone grants reading
* every matched saved query with full content, private ones included;
* bindings are ignored. Use parent "projects/-" for all projects.
+ * Results default to title ascending; see `order_by`.
* Permissions required: bb.savedQueries.list on the project, or on the
* workspace when the parent is "projects/-"
*
diff --git a/frontend/src/types/proto-es/v1/saved_query_service_pb.js b/frontend/src/types/proto-es/v1/saved_query_service_pb.js
index c9cd4abb28..7f5184cfc7 100644
--- a/frontend/src/types/proto-es/v1/saved_query_service_pb.js
+++ b/frontend/src/types/proto-es/v1/saved_query_service_pb.js
@@ -15,7 +15,7 @@ import { file_v1_annotation } from "./annotation_pb";
* Describes the file v1/saved_query_service.proto.
*/
export const file_v1_saved_query_service = /*@__PURE__*/
- fileDesc("Chx2MS9zYXZlZF9xdWVyeV9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSJ6ChdDcmVhdGVTYXZlZFF1ZXJ5UmVxdWVzdBIsCgZwYXJlbnQYASABKAlCHOBBAvpBFgoUYnl0ZWJhc2UuY29tL1Byb2plY3QSMQoLc2F2ZWRfcXVlcnkYAiABKAsyFy5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5QgPgQQIiRQoUR2V0U2F2ZWRRdWVyeVJlcXVlc3QSLQoEbmFtZRgBIAEoCUIf4EEC+kEZChdieXRlYmFzZS5jb20vU2F2ZWRRdWVyeSJ+ChdMaXN0U2F2ZWRRdWVyaWVzUmVxdWVzdBIsCgZwYXJlbnQYASABKAlCHOBBAvpBFgoUYnl0ZWJhc2UuY29tL1Byb2plY3QSDgoGZmlsdGVyGAIgASgJEhEKCXBhZ2Vfc2l6ZRgDIAEoBRISCgpwYWdlX3Rva2VuGAQgASgJImMKGExpc3RTYXZlZFF1ZXJpZXNSZXNwb25zZRIuCg1zYXZlZF9xdWVyaWVzGAEgAygLMhcuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeRIXCg9uZXh0X3BhZ2VfdG9rZW4YAiABKAkiXgoeU2VhcmNoU2F2ZWRRdWVyeUZvbGRlcnNSZXF1ZXN0EiwKBnBhcmVudBgBIAEoCUIc4EEC+kEWChRieXRlYmFzZS5jb20vUHJvamVjdBIOCgZmaWx0ZXIYAiABKAkiMgofU2VhcmNoU2F2ZWRRdWVyeUZvbGRlcnNSZXNwb25zZRIPCgdmb2xkZXJzGAEgAygJIn0KF1VwZGF0ZVNhdmVkUXVlcnlSZXF1ZXN0EjEKC3NhdmVkX3F1ZXJ5GAEgASgLMhcuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeUID4EECEi8KC3VwZGF0ZV9tYXNrGAIgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzayJdChtVcGRhdGVTYXZlZFF1ZXJ5U3RhclJlcXVlc3QSLQoEbmFtZRgBIAEoCUIf4EEC+kEZChdieXRlYmFzZS5jb20vU2F2ZWRRdWVyeRIPCgdzdGFycmVkGAIgASgIIpABChlNb3ZlTXlTYXZlZFF1ZXJpZXNSZXF1ZXN0EiwKBnBhcmVudBgBIAEoCUIc4EEC+kEWChRieXRlYmFzZS5jb20vUHJvamVjdBIkCg1zb3VyY2VfZm9sZGVyGAIgASgJQg3gQQK6SAdyBRABGIACEh8KDXRhcmdldF9mb2xkZXIYAyABKAlCCLpIBXIDGIACIjEKGk1vdmVNeVNhdmVkUXVlcmllc1Jlc3BvbnNlEhMKC21vdmVkX2NvdW50GAEgASgFIk8KGkdldFNhdmVkUXVlcnlQb2xpY3lSZXF1ZXN0EjEKCHJlc291cmNlGAEgASgJQh/gQQL6QRkKF2J5dGViYXNlLmNvbS9TYXZlZFF1ZXJ5IoMBChpTZXRTYXZlZFF1ZXJ5UG9saWN5UmVxdWVzdBIxCghyZXNvdXJjZRgBIAEoCUIf4EEC+kEZChdieXRlYmFzZS5jb20vU2F2ZWRRdWVyeRIyCgZwb2xpY3kYAiABKAsyHS5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5UG9saWN5QgPgQQIiUgoQU2F2ZWRRdWVyeVBvbGljeRIwCghiaW5kaW5ncxgBIAMoCzIeLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnlCaW5kaW5nEgwKBGV0YWcYAiABKAkiowEKEVNhdmVkUXVlcnlCaW5kaW5nEjgKBWxldmVsGAEgASgOMiQuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeUJpbmRpbmcuTGV2ZWxCA+BBAhIcCgdtZW1iZXJzGAIgAygJQgvgQQK6SAWSAQIIASI2CgVMZXZlbBIVChFMRVZFTF9VTlNQRUNJRklFRBAAEgoKBlZJRVdFUhABEgoKBkVESVRPUhACIkgKF0RlbGV0ZVNhdmVkUXVlcnlSZXF1ZXN0Ei0KBG5hbWUYASABKAlCH+BBAvpBGQoXYnl0ZWJhc2UuY29tL1NhdmVkUXVlcnkigAEKGVNlYXJjaFNhdmVkUXVlcmllc1JlcXVlc3QSLAoGcGFyZW50GAEgASgJQhzgQQL6QRYKFGJ5dGViYXNlLmNvbS9Qcm9qZWN0Eg4KBmZpbHRlchgCIAEoCRIRCglwYWdlX3NpemUYAyABKAUSEgoKcGFnZV90b2tlbhgEIAEoCSJlChpTZWFyY2hTYXZlZFF1ZXJpZXNSZXNwb25zZRIuCg1zYXZlZF9xdWVyaWVzGAEgAygLMhcuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeRIXCg9uZXh0X3BhZ2VfdG9rZW4YAiABKAkiogMKClNhdmVkUXVlcnkSFAoEbmFtZRgBIAEoCUIG4EEC4EEFEhQKB3Byb2plY3QYAiABKAlCA+BBAxIQCghkYXRhYmFzZRgDIAEoCRIaCgV0aXRsZRgEIAEoCUIL4EECukgFcgMYyAESFAoHY3JlYXRvchgFIAEoCUID4EEDEjQKC2NyZWF0ZV90aW1lGAYgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEjQKC3VwZGF0ZV90aW1lGAcgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEhQKB2NvbnRlbnQYCCABKAxCA+BBAhIZCgxjb250ZW50X3NpemUYCSABKANCA+BBAxIUCgdzdGFycmVkGAsgASgIQgPgQQMSGAoGZm9sZGVyGA0gASgJQgi6SAVyAxiAAjpL6kFIChdieXRlYmFzZS5jb20vU2F2ZWRRdWVyeRItcHJvamVjdHMve3Byb2plY3R9L3NhdmVkUXVlcmllcy97c2F2ZWRfcXVlcnl9SgQIChALSgQIDBANMuYPChFTYXZlZFF1ZXJ5U2VydmljZRLHAQoQQ3JlYXRlU2F2ZWRRdWVyeRIkLmJ5dGViYXNlLnYxLkNyZWF0ZVNhdmVkUXVlcnlSZXF1ZXN0GhcuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeSJ02kEScGFyZW50LHNhdmVkX3F1ZXJ5iuowFmJiLnNhdmVkUXVlcmllcy5jcmVhdGWQ6jABmOowAaDqMAKC0+STAjM6C3NhdmVkX3F1ZXJ5IiQvdjEve3BhcmVudD1wcm9qZWN0cy8qfS9zYXZlZFF1ZXJpZXMSiAEKDUdldFNhdmVkUXVlcnkSIS5ieXRlYmFzZS52MS5HZXRTYXZlZFF1ZXJ5UmVxdWVzdBoXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnkiO9pBBG5hbWWQ6jACoOowAYLT5JMCJhIkL3YxL3tuYW1lPXByb2plY3RzLyovc2F2ZWRRdWVyaWVzLyp9EroBChBMaXN0U2F2ZWRRdWVyaWVzEiQuYnl0ZWJhc2UudjEuTGlzdFNhdmVkUXVlcmllc1JlcXVlc3QaJS5ieXRlYmFzZS52MS5MaXN0U2F2ZWRRdWVyaWVzUmVzcG9uc2UiWdpBBnBhcmVudIrqMBRiYi5zYXZlZFF1ZXJpZXMubGlzdJDqMAGg6jAEsOowAoLT5JMCJhIkL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vc2F2ZWRRdWVyaWVzEq4BChJTZWFyY2hTYXZlZFF1ZXJpZXMSJi5ieXRlYmFzZS52MS5TZWFyY2hTYXZlZFF1ZXJpZXNSZXF1ZXN0GicuYnl0ZWJhc2UudjEuU2VhcmNoU2F2ZWRRdWVyaWVzUmVzcG9uc2UiR9pBBnBhcmVudJDqMAKg6jABgtPkkwIwOgEqIisvdjEve3BhcmVudD1wcm9qZWN0cy8qfS9zYXZlZFF1ZXJpZXM6c2VhcmNoEsQBChdTZWFyY2hTYXZlZFF1ZXJ5Rm9sZGVycxIrLmJ5dGViYXNlLnYxLlNlYXJjaFNhdmVkUXVlcnlGb2xkZXJzUmVxdWVzdBosLmJ5dGViYXNlLnYxLlNlYXJjaFNhdmVkUXVlcnlGb2xkZXJzUmVzcG9uc2UiTtpBBnBhcmVudJDqMAKg6jABgtPkkwI3OgEqIjIvdjEve3BhcmVudD1wcm9qZWN0cy8qfS9zYXZlZFF1ZXJpZXM6c2VhcmNoRm9sZGVycxK+AQoQVXBkYXRlU2F2ZWRRdWVyeRIkLmJ5dGViYXNlLnYxLlVwZGF0ZVNhdmVkUXVlcnlSZXF1ZXN0GhcuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeSJr2kEXc2F2ZWRfcXVlcnksdXBkYXRlX21hc2uQ6jACmOowAaDqMAKC0+STAj86C3NhdmVkX3F1ZXJ5MjAvdjEve3NhdmVkX3F1ZXJ5Lm5hbWU9cHJvamVjdHMvKi9zYXZlZFF1ZXJpZXMvKn0SrAEKFFVwZGF0ZVNhdmVkUXVlcnlTdGFyEiguYnl0ZWJhc2UudjEuVXBkYXRlU2F2ZWRRdWVyeVN0YXJSZXF1ZXN0GhcuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeSJR2kEMbmFtZSxzdGFycmVkkOowAqDqMAKC0+STAjQ6ASoiLy92MS97bmFtZT1wcm9qZWN0cy8qL3NhdmVkUXVlcmllcy8qfTp1cGRhdGVTdGFyEs4BChJNb3ZlTXlTYXZlZFF1ZXJpZXMSJi5ieXRlYmFzZS52MS5Nb3ZlTXlTYXZlZFF1ZXJpZXNSZXF1ZXN0GicuYnl0ZWJhc2UudjEuTW92ZU15U2F2ZWRRdWVyaWVzUmVzcG9uc2UiZ9pBInBhcmVudCxzb3VyY2VfZm9sZGVyLHRhcmdldF9mb2xkZXKQ6jACmOowAaDqMAKC0+STAjA6ASoiKy92MS97cGFyZW50PXByb2plY3RzLyp9L3NhdmVkUXVlcmllczptb3ZlTXkSkQEKEERlbGV0ZVNhdmVkUXVlcnkSJC5ieXRlYmFzZS52MS5EZWxldGVTYXZlZFF1ZXJ5UmVxdWVzdBoWLmdvb2dsZS5wcm90b2J1Zi5FbXB0eSI/2kEEbmFtZZDqMAKY6jABoOowAoLT5JMCJiokL3YxL3tuYW1lPXByb2plY3RzLyovc2F2ZWRRdWVyaWVzLyp9ErABChNHZXRTYXZlZFF1ZXJ5UG9saWN5EicuYnl0ZWJhc2UudjEuR2V0U2F2ZWRRdWVyeVBvbGljeVJlcXVlc3QaHS5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5UG9saWN5IlHaQQhyZXNvdXJjZZDqMAKg6jAEsOowAYLT5JMCNBIyL3YxL3tyZXNvdXJjZT1wcm9qZWN0cy8qL3NhdmVkUXVlcmllcy8qfTpnZXRQb2xpY3kSvgEKE1NldFNhdmVkUXVlcnlQb2xpY3kSJy5ieXRlYmFzZS52MS5TZXRTYXZlZFF1ZXJ5UG9saWN5UmVxdWVzdBodLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnlQb2xpY3kiX9pBD3Jlc291cmNlLHBvbGljeZDqMAKY6jABoOowBLDqMAGC0+STAjc6ASoiMi92MS97cmVzb3VyY2U9cHJvamVjdHMvKi9zYXZlZFF1ZXJpZXMvKn06c2V0UG9saWN5QqwBCg9jb20uYnl0ZWJhc2UudjFCFlNhdmVkUXVlcnlTZXJ2aWNlUHJvdG9QAVo0Z2l0aHViLmNvbS9ieXRlYmFzZS9ieXRlYmFzZS9iYWNrZW5kL2dlbmVyYXRlZC1nby92MaICA0JYWKoCC0J5dGViYXNlLlYxygILQnl0ZWJhc2VcVjHiAhdCeXRlYmFzZVxWMVxHUEJNZXRhZGF0YeoCDEJ5dGViYXNlOjpWMWIGcHJvdG8z", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation]);
+ fileDesc("Chx2MS9zYXZlZF9xdWVyeV9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSJ6ChdDcmVhdGVTYXZlZFF1ZXJ5UmVxdWVzdBIsCgZwYXJlbnQYASABKAlCHOBBAvpBFgoUYnl0ZWJhc2UuY29tL1Byb2plY3QSMQoLc2F2ZWRfcXVlcnkYAiABKAsyFy5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5QgPgQQIiRQoUR2V0U2F2ZWRRdWVyeVJlcXVlc3QSLQoEbmFtZRgBIAEoCUIf4EEC+kEZChdieXRlYmFzZS5jb20vU2F2ZWRRdWVyeSKQAQoXTGlzdFNhdmVkUXVlcmllc1JlcXVlc3QSLAoGcGFyZW50GAEgASgJQhzgQQL6QRYKFGJ5dGViYXNlLmNvbS9Qcm9qZWN0Eg4KBmZpbHRlchgCIAEoCRIRCglwYWdlX3NpemUYAyABKAUSEgoKcGFnZV90b2tlbhgEIAEoCRIQCghvcmRlcl9ieRgFIAEoCSJjChhMaXN0U2F2ZWRRdWVyaWVzUmVzcG9uc2USLgoNc2F2ZWRfcXVlcmllcxgBIAMoCzIXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnkSFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJIl4KHlNlYXJjaFNhdmVkUXVlcnlGb2xkZXJzUmVxdWVzdBIsCgZwYXJlbnQYASABKAlCHOBBAvpBFgoUYnl0ZWJhc2UuY29tL1Byb2plY3QSDgoGZmlsdGVyGAIgASgJIjIKH1NlYXJjaFNhdmVkUXVlcnlGb2xkZXJzUmVzcG9uc2USDwoHZm9sZGVycxgBIAMoCSJ9ChdVcGRhdGVTYXZlZFF1ZXJ5UmVxdWVzdBIxCgtzYXZlZF9xdWVyeRgBIAEoCzIXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnlCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2siXQobVXBkYXRlU2F2ZWRRdWVyeVN0YXJSZXF1ZXN0Ei0KBG5hbWUYASABKAlCH+BBAvpBGQoXYnl0ZWJhc2UuY29tL1NhdmVkUXVlcnkSDwoHc3RhcnJlZBgCIAEoCCKQAQoZTW92ZU15U2F2ZWRRdWVyaWVzUmVxdWVzdBIsCgZwYXJlbnQYASABKAlCHOBBAvpBFgoUYnl0ZWJhc2UuY29tL1Byb2plY3QSJAoNc291cmNlX2ZvbGRlchgCIAEoCUIN4EECukgHcgUQARiAAhIfCg10YXJnZXRfZm9sZGVyGAMgASgJQgi6SAVyAxiAAiIxChpNb3ZlTXlTYXZlZFF1ZXJpZXNSZXNwb25zZRITCgttb3ZlZF9jb3VudBgBIAEoBSJPChpHZXRTYXZlZFF1ZXJ5UG9saWN5UmVxdWVzdBIxCghyZXNvdXJjZRgBIAEoCUIf4EEC+kEZChdieXRlYmFzZS5jb20vU2F2ZWRRdWVyeSKDAQoaU2V0U2F2ZWRRdWVyeVBvbGljeVJlcXVlc3QSMQoIcmVzb3VyY2UYASABKAlCH+BBAvpBGQoXYnl0ZWJhc2UuY29tL1NhdmVkUXVlcnkSMgoGcG9saWN5GAIgASgLMh0uYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeVBvbGljeUID4EECIlIKEFNhdmVkUXVlcnlQb2xpY3kSMAoIYmluZGluZ3MYASADKAsyHi5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5QmluZGluZxIMCgRldGFnGAIgASgJIqMBChFTYXZlZFF1ZXJ5QmluZGluZxI4CgVsZXZlbBgBIAEoDjIkLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnlCaW5kaW5nLkxldmVsQgPgQQISHAoHbWVtYmVycxgCIAMoCUIL4EECukgFkgECCAEiNgoFTGV2ZWwSFQoRTEVWRUxfVU5TUEVDSUZJRUQQABIKCgZWSUVXRVIQARIKCgZFRElUT1IQAiJIChdEZWxldGVTYXZlZFF1ZXJ5UmVxdWVzdBItCgRuYW1lGAEgASgJQh/gQQL6QRkKF2J5dGViYXNlLmNvbS9TYXZlZFF1ZXJ5IoABChlTZWFyY2hTYXZlZFF1ZXJpZXNSZXF1ZXN0EiwKBnBhcmVudBgBIAEoCUIc4EEC+kEWChRieXRlYmFzZS5jb20vUHJvamVjdBIOCgZmaWx0ZXIYAiABKAkSEQoJcGFnZV9zaXplGAMgASgFEhIKCnBhZ2VfdG9rZW4YBCABKAkiZQoaU2VhcmNoU2F2ZWRRdWVyaWVzUmVzcG9uc2USLgoNc2F2ZWRfcXVlcmllcxgBIAMoCzIXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnkSFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJIqIDCgpTYXZlZFF1ZXJ5EhQKBG5hbWUYASABKAlCBuBBAuBBBRIUCgdwcm9qZWN0GAIgASgJQgPgQQMSEAoIZGF0YWJhc2UYAyABKAkSGgoFdGl0bGUYBCABKAlCC+BBArpIBXIDGMgBEhQKB2NyZWF0b3IYBSABKAlCA+BBAxI0CgtjcmVhdGVfdGltZRgGIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCA+BBAxI0Cgt1cGRhdGVfdGltZRgHIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCA+BBAxIUCgdjb250ZW50GAggASgMQgPgQQISGQoMY29udGVudF9zaXplGAkgASgDQgPgQQMSFAoHc3RhcnJlZBgLIAEoCEID4EEDEhgKBmZvbGRlchgNIAEoCUIIukgFcgMYgAI6S+pBSAoXYnl0ZWJhc2UuY29tL1NhdmVkUXVlcnkSLXByb2plY3RzL3twcm9qZWN0fS9zYXZlZFF1ZXJpZXMve3NhdmVkX3F1ZXJ5fUoECAoQC0oECAwQDTLmDwoRU2F2ZWRRdWVyeVNlcnZpY2USxwEKEENyZWF0ZVNhdmVkUXVlcnkSJC5ieXRlYmFzZS52MS5DcmVhdGVTYXZlZFF1ZXJ5UmVxdWVzdBoXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnkidNpBEnBhcmVudCxzYXZlZF9xdWVyeYrqMBZiYi5zYXZlZFF1ZXJpZXMuY3JlYXRlkOowAZjqMAGg6jACgtPkkwIzOgtzYXZlZF9xdWVyeSIkL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vc2F2ZWRRdWVyaWVzEogBCg1HZXRTYXZlZFF1ZXJ5EiEuYnl0ZWJhc2UudjEuR2V0U2F2ZWRRdWVyeVJlcXVlc3QaFy5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5IjvaQQRuYW1lkOowAqDqMAGC0+STAiYSJC92MS97bmFtZT1wcm9qZWN0cy8qL3NhdmVkUXVlcmllcy8qfRK6AQoQTGlzdFNhdmVkUXVlcmllcxIkLmJ5dGViYXNlLnYxLkxpc3RTYXZlZFF1ZXJpZXNSZXF1ZXN0GiUuYnl0ZWJhc2UudjEuTGlzdFNhdmVkUXVlcmllc1Jlc3BvbnNlIlnaQQZwYXJlbnSK6jAUYmIuc2F2ZWRRdWVyaWVzLmxpc3SQ6jABoOowBLDqMAKC0+STAiYSJC92MS97cGFyZW50PXByb2plY3RzLyp9L3NhdmVkUXVlcmllcxKuAQoSU2VhcmNoU2F2ZWRRdWVyaWVzEiYuYnl0ZWJhc2UudjEuU2VhcmNoU2F2ZWRRdWVyaWVzUmVxdWVzdBonLmJ5dGViYXNlLnYxLlNlYXJjaFNhdmVkUXVlcmllc1Jlc3BvbnNlIkfaQQZwYXJlbnSQ6jACoOowAYLT5JMCMDoBKiIrL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vc2F2ZWRRdWVyaWVzOnNlYXJjaBLEAQoXU2VhcmNoU2F2ZWRRdWVyeUZvbGRlcnMSKy5ieXRlYmFzZS52MS5TZWFyY2hTYXZlZFF1ZXJ5Rm9sZGVyc1JlcXVlc3QaLC5ieXRlYmFzZS52MS5TZWFyY2hTYXZlZFF1ZXJ5Rm9sZGVyc1Jlc3BvbnNlIk7aQQZwYXJlbnSQ6jACoOowAYLT5JMCNzoBKiIyL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vc2F2ZWRRdWVyaWVzOnNlYXJjaEZvbGRlcnMSvgEKEFVwZGF0ZVNhdmVkUXVlcnkSJC5ieXRlYmFzZS52MS5VcGRhdGVTYXZlZFF1ZXJ5UmVxdWVzdBoXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnkia9pBF3NhdmVkX3F1ZXJ5LHVwZGF0ZV9tYXNrkOowApjqMAGg6jACgtPkkwI/OgtzYXZlZF9xdWVyeTIwL3YxL3tzYXZlZF9xdWVyeS5uYW1lPXByb2plY3RzLyovc2F2ZWRRdWVyaWVzLyp9EqwBChRVcGRhdGVTYXZlZFF1ZXJ5U3RhchIoLmJ5dGViYXNlLnYxLlVwZGF0ZVNhdmVkUXVlcnlTdGFyUmVxdWVzdBoXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnkiUdpBDG5hbWUsc3RhcnJlZJDqMAKg6jACgtPkkwI0OgEqIi8vdjEve25hbWU9cHJvamVjdHMvKi9zYXZlZFF1ZXJpZXMvKn06dXBkYXRlU3RhchLOAQoSTW92ZU15U2F2ZWRRdWVyaWVzEiYuYnl0ZWJhc2UudjEuTW92ZU15U2F2ZWRRdWVyaWVzUmVxdWVzdBonLmJ5dGViYXNlLnYxLk1vdmVNeVNhdmVkUXVlcmllc1Jlc3BvbnNlImfaQSJwYXJlbnQsc291cmNlX2ZvbGRlcix0YXJnZXRfZm9sZGVykOowApjqMAGg6jACgtPkkwIwOgEqIisvdjEve3BhcmVudD1wcm9qZWN0cy8qfS9zYXZlZFF1ZXJpZXM6bW92ZU15EpEBChBEZWxldGVTYXZlZFF1ZXJ5EiQuYnl0ZWJhc2UudjEuRGVsZXRlU2F2ZWRRdWVyeVJlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiP9pBBG5hbWWQ6jACmOowAaDqMAKC0+STAiYqJC92MS97bmFtZT1wcm9qZWN0cy8qL3NhdmVkUXVlcmllcy8qfRKwAQoTR2V0U2F2ZWRRdWVyeVBvbGljeRInLmJ5dGViYXNlLnYxLkdldFNhdmVkUXVlcnlQb2xpY3lSZXF1ZXN0Gh0uYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeVBvbGljeSJR2kEIcmVzb3VyY2WQ6jACoOowBLDqMAGC0+STAjQSMi92MS97cmVzb3VyY2U9cHJvamVjdHMvKi9zYXZlZFF1ZXJpZXMvKn06Z2V0UG9saWN5Er4BChNTZXRTYXZlZFF1ZXJ5UG9saWN5EicuYnl0ZWJhc2UudjEuU2V0U2F2ZWRRdWVyeVBvbGljeVJlcXVlc3QaHS5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5UG9saWN5Il/aQQ9yZXNvdXJjZSxwb2xpY3mQ6jACmOowAaDqMASw6jABgtPkkwI3OgEqIjIvdjEve3Jlc291cmNlPXByb2plY3RzLyovc2F2ZWRRdWVyaWVzLyp9OnNldFBvbGljeUKsAQoPY29tLmJ5dGViYXNlLnYxQhZTYXZlZFF1ZXJ5U2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_api_resource, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation]);
/**
* Describes the message bytebase.v1.CreateSavedQueryRequest.
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index f939419bb1..de5c5abfe3 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -12965,6 +12965,7 @@ paths:
summary: ListQueryHistories
description: |-
ListQueryHistories lists query histories of all users in a project.
+ Results are ordered by create time descending (newest first).
Permissions required: bb.queryHistories.list
operationId: QueryHistoryService_ListQueryHistories
parameters:
@@ -13708,6 +13709,7 @@ paths:
List saved queries for auditing. The permission alone grants reading
every matched saved query with full content, private ones included;
bindings are ignored. Use parent "projects/-" for all projects.
+ Results default to title ascending; see `order_by`.
Permissions required: bb.savedQueries.list on the project, or on the
workspace when the parent is "projects/-"
operationId: SavedQueryService_ListSavedQueries
@@ -13748,6 +13750,19 @@ paths:
schema:
type: string
title: page_token
+ - name: orderBy
+ in: query
+ description: |-
+ Sort the results, per https://google.aip.dev/132#ordering. Supported
+ fields: `update_time`, `create_time`, `title`; append " desc" for
+ descending, e.g. "update_time desc" for most recently modified first.
+ A modification is a title, content, database, or folder write; sharing
+ and stars do not count, and a never-modified saved query counts its
+ create time. Empty means `title` ascending. `resource_id` is always
+ appended as a final tiebreak so pages stay stable.
+ schema:
+ type: string
+ title: order_by
responses:
"200":
description: Success
@@ -25532,6 +25547,17 @@ components:
description: |-
A page token from a previous ListSavedQueries call. Keep every other
parameter the same as the call that returned it.
+ orderBy:
+ type: string
+ title: order_by
+ description: |-
+ Sort the results, per https://google.aip.dev/132#ordering. Supported
+ fields: `update_time`, `create_time`, `title`; append " desc" for
+ descending, e.g. "update_time desc" for most recently modified first.
+ A modification is a title, content, database, or folder write; sharing
+ and stars do not count, and a never-modified saved query counts its
+ create time. Empty means `title` ascending. `resource_id` is always
+ appended as a final tiebreak so pages stay stable.
title: ListSavedQueriesRequest
required:
- parent
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index c48917c404..bb2eb5960f 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -2934,7 +2934,7 @@ QueryHistoryService manages query history records of SQL Editor queries and expo
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| SearchQueryHistories | [SearchQueryHistoriesRequest](#bytebase-v1-SearchQueryHistoriesRequest) | [SearchQueryHistoriesResponse](#bytebase-v1-SearchQueryHistoriesResponse) | SearchQueryHistories searches query histories for the caller. Permissions required: None (only returns caller&#39;s own query histories) |
-| ListQueryHistories | [ListQueryHistoriesRequest](#bytebase-v1-ListQueryHistoriesRequest) | [ListQueryHistoriesResponse](#bytebase-v1-ListQueryHistoriesResponse) | ListQueryHistories lists query histories of all users in a project. Permissions required: bb.queryHistories.list |
+| ListQueryHistories | [ListQueryHistoriesRequest](#bytebase-v1-ListQueryHistoriesRequest) | [ListQueryHistoriesResponse](#bytebase-v1-ListQueryHistoriesResponse) | ListQueryHistories lists query histories of all users in a project. Results are ordered by create time descending (newest first). Permissions required: bb.queryHistories.list |
| GetQueryHistory | [GetQueryHistoryRequest](#bytebase-v1-GetQueryHistoryRequest) | [QueryHistory](#bytebase-v1-QueryHistory) | GetQueryHistory gets a single query history for the caller. Permissions required: None (only returns the caller&#39;s own query history) |
@@ -11183,6 +11183,7 @@ Supported fields: - creator: the creator in &#34;users/{email}&#34; format. Supp
For example: creator == &#34;users/[email protected]&#34; |
| page_size | [int32](#int32) | | The maximum number of saved queries to return. The service may return fewer. Defaults to 10; values above 1000 are coerced to 1000. |
| page_token | [string](#string) | | A page token from a previous ListSavedQueries call. Keep every other parameter the same as the call that returned it. |
+| order_by | [string](#string) | | Sort the results, per https://google.aip.dev/132#ordering. Supported fields: `update_time`, `create_time`, `title`; append &#34; desc&#34; for descending, e.g. &#34;update_time desc&#34; for most recently modified first. A modification is a title, content, database, or folder write; sharing and stars do not count, and a never-modified saved query counts its create time. Empty means `title` ascending. `resource_id` is always appended as a final tiebreak so pages stay stable. |
@@ -11456,7 +11457,7 @@ is governed by the SQL Editor&#39;s database permissions, not by this service.
| ----------- | ------------ | ------------- | ------------|
| CreateSavedQuery | [CreateSavedQueryRequest](#bytebase-v1-CreateSavedQueryRequest) | [SavedQuery](#bytebase-v1-SavedQuery) | Create a saved query. The creator becomes the owner and the saved query starts private. Permissions required: bb.savedQueries.create on the project |
| GetSavedQuery | [GetSavedQueryRequest](#bytebase-v1-GetSavedQueryRequest) | [SavedQuery](#bytebase-v1-SavedQuery) | Get a saved query with its full content. Permissions required: bb.savedQueries.get (creator, VIEWER/EDITOR binding, or project-level grant) |
-| ListSavedQueries | [ListSavedQueriesRequest](#bytebase-v1-ListSavedQueriesRequest) | [ListSavedQueriesResponse](#bytebase-v1-ListSavedQueriesResponse) | List saved queries for auditing. The permission alone grants reading every matched saved query with full content, private ones included; bindings are ignored. Use parent &#34;projects/-&#34; for all projects. Permissions required: bb.savedQueries.list on the project, or on the workspace when the parent is &#34;projects/-&#34; |
+| ListSavedQueries | [ListSavedQueriesRequest](#bytebase-v1-ListSavedQueriesRequest) | [ListSavedQueriesResponse](#bytebase-v1-ListSavedQueriesResponse) | List saved queries for auditing. The permission alone grants reading every matched saved query with full content, private ones included; bindings are ignored. Use parent &#34;projects/-&#34; for all projects. Results default to title ascending; see `order_by`. Permissions required: bb.savedQueries.list on the project, or on the workspace when the parent is &#34;projects/-&#34; |
| SearchSavedQueries | [SearchSavedQueriesRequest](#bytebase-v1-SearchSavedQueriesRequest) | [SearchSavedQueriesResponse](#bytebase-v1-SearchSavedQueriesResponse) | Search saved queries in one project. Returns content previews of the saved queries the caller can read, the same access rule as GetSavedQuery. Permissions required: bb.savedQueries.search on the project |
| SearchSavedQueryFolders | [SearchSavedQueryFoldersRequest](#bytebase-v1-SearchSavedQueryFoldersRequest) | [SearchSavedQueryFoldersResponse](#bytebase-v1-SearchSavedQueryFoldersResponse) | Search folder paths. A path is returned when it holds at least one saved query the caller can read, the same access rule as SearchSavedQueries. Permissions required: bb.savedQueries.search on the project |
| UpdateSavedQuery | [UpdateSavedQueryRequest](#bytebase-v1-UpdateSavedQueryRequest) | [SavedQuery](#bytebase-v1-SavedQuery) | Update a saved query. `database` must belong to the saved query&#39;s project. Permissions required: bb.savedQueries.update (creator, EDITOR binding, or project-level grant) |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index 095559833d..e7dfeb51ad 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -8903,6 +8903,7 @@ Permissions required: None (only returns caller&#39;s own query histories)</p></
<td><a href="#bytebase.v1.ListQueryHistoriesRequest">ListQueryHistoriesRequest</a></td>
<td><a href="#bytebase.v1.ListQueryHistoriesResponse">ListQueryHistoriesResponse</a></td>
<td><p>ListQueryHistories lists query histories of all users in a project.
+Results are ordered by create time descending (newest first).
Permissions required: bb.queryHistories.list</p></td>
</tr>
@@ -31891,6 +31892,19 @@ fewer. Defaults to 10; values above 1000 are coerced to 1000. </p></td>
parameter the same as the call that returned it. </p></td>
</tr>
+ <tr>
+ <td>order_by</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Sort the results, per https://google.aip.dev/132#ordering. Supported
+fields: `update_time`, `create_time`, `title`; append &#34; desc&#34; for
+descending, e.g. &#34;update_time desc&#34; for most recently modified first.
+A modification is a title, content, database, or folder write; sharing
+and stars do not count, and a never-modified saved query counts its
+create time. Empty means `title` ascending. `resource_id` is always
+appended as a final tiebreak so pages stay stable. </p></td>
+ </tr>
+
</tbody>
</table>
@@ -32488,6 +32502,7 @@ binding, or project-level grant)</p></td>
<td><p>List saved queries for auditing. The permission alone grants reading
every matched saved query with full content, private ones included;
bindings are ignored. Use parent &#34;projects/-&#34; for all projects.
+Results default to title ascending; see `order_by`.
Permissions required: bb.savedQueries.list on the project, or on the
workspace when the parent is &#34;projects/-&#34;</p></td>
</tr>
diff --git a/proto/v1/v1/query_history_service.proto b/proto/v1/v1/query_history_service.proto
index 0e8b8fd927..42caeab695 100644
--- a/proto/v1/v1/query_history_service.proto
+++ b/proto/v1/v1/query_history_service.proto
@@ -27,6 +27,7 @@ service QueryHistoryService {
}
// ListQueryHistories lists query histories of all users in a project.
+ // Results are ordered by create time descending (newest first).
// Permissions required: bb.queryHistories.list
rpc ListQueryHistories(ListQueryHistoriesRequest) returns (ListQueryHistoriesResponse) {
option (google.api.http) = {get: "/v1/{parent=projects/*}/queryHistories"};
diff --git a/proto/v1/v1/saved_query_service.proto b/proto/v1/v1/saved_query_service.proto
index a8e63f472e..92d8dc0f5e 100644
--- a/proto/v1/v1/saved_query_service.proto
+++ b/proto/v1/v1/saved_query_service.proto
@@ -55,6 +55,7 @@ service SavedQueryService {
// List saved queries for auditing. The permission alone grants reading
// every matched saved query with full content, private ones included;
// bindings are ignored. Use parent "projects/-" for all projects.
+ // Results default to title ascending; see `order_by`.
// Permissions required: bb.savedQueries.list on the project, or on the
// workspace when the parent is "projects/-"
rpc ListSavedQueries(ListSavedQueriesRequest) returns (ListSavedQueriesResponse) {
@@ -223,6 +224,15 @@ message ListSavedQueriesRequest {
// A page token from a previous ListSavedQueries call. Keep every other
// parameter the same as the call that returned it.
string page_token = 4;
+
+ // Sort the results, per https://google.aip.dev/132#ordering. Supported
+ // fields: `update_time`, `create_time`, `title`; append " desc" for
+ // descending, e.g. "update_time desc" for most recently modified first.
+ // A modification is a title, content, database, or folder write; sharing
+ // and stars do not count, and a never-modified saved query counts its
+ // create time. Empty means `title` ascending. `resource_id` is always
+ // appended as a final tiebreak so pages stay stable.
+ string order_by = 5;
}
message ListSavedQueriesResponse {