Skip to content

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

chore: prepare folder for worksheet (#17989)

ecmadao8e8842749f05
diff --git a/backend/api/v1/worksheet_service.go b/backend/api/v1/worksheet_service.go
index 2ae1db6321..6309b06ec8 100644
--- a/backend/api/v1/worksheet_service.go
+++ b/backend/api/v1/worksheet_service.go
@@ -359,14 +359,19 @@ func (s *WorksheetService) UpdateWorksheetOrganizer(
if !ok {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("user not found"))
}
- worksheetOrganizerUpsert := &store.WorksheetOrganizerMessage{
- WorksheetUID: worksheetUID,
- PrincipalUID: user.ID,
+ worksheetOrganizerUpsert, err := s.store.GetWorksheetOrganizer(ctx, worksheetUID, user.ID)
+ if err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to found worksheet organizer with error: %v", err))
}
for _, path := range request.UpdateMask.Paths {
- if path == "starred" {
- worksheetOrganizerUpsert.Starred = request.Organizer.Starred
+ switch path {
+ case "starred":
+ worksheetOrganizerUpsert.Payload.Starred = request.Organizer.Starred
+ case "folders":
+ worksheetOrganizerUpsert.Payload.Folders = request.Organizer.Folders
+ default:
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid update mask path %q", path))
}
}
@@ -377,7 +382,8 @@ func (s *WorksheetService) UpdateWorksheetOrganizer(
return connect.NewResponse(&v1pb.WorksheetOrganizer{
Worksheet: request.Organizer.Worksheet,
- Starred: organizer.Starred,
+ Starred: organizer.Payload.Starred,
+ Folders: organizer.Payload.Folders,
}), nil
}
@@ -539,6 +545,7 @@ func (s *WorksheetService) convertToAPIWorksheetMessage(ctx context.Context, wor
ContentSize: worksheet.Size,
Visibility: visibility,
Starred: worksheet.Starred,
+ Folders: worksheet.Folders,
}, nil
}
diff --git a/backend/generated-go/store/worksheet.pb.go b/backend/generated-go/store/worksheet.pb.go
new file mode 100644
index 0000000000..1b662329fa
--- /dev/null
+++ b/backend/generated-go/store/worksheet.pb.go
@@ -0,0 +1,134 @@
+// Code generated by protoc-gen-go. DO NOT EDIT.
+// versions:
+// protoc-gen-go v1.36.10
+// protoc (unknown)
+// source: store/worksheet.proto
+
+package store
+
+import (
+ protoreflect "google.golang.org/protobuf/reflect/protoreflect"
+ protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+ reflect "reflect"
+ sync "sync"
+ unsafe "unsafe"
+)
+
+const (
+ // Verify that this generated code is sufficiently up-to-date.
+ _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
+ // Verify that runtime/protoimpl is sufficiently up-to-date.
+ _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
+)
+
+type WorkSheetOrganizerPayload struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ Starred bool `protobuf:"varint,1,opt,name=starred,proto3" json:"starred,omitempty"`
+ // The folder path for a worksheet.
+ // For example, if the folders is [A, B, C], means the worksheet is in the A/B/C subfolder.
+ Folders []string `protobuf:"bytes,2,rep,name=folders,proto3" json:"folders,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *WorkSheetOrganizerPayload) Reset() {
+ *x = WorkSheetOrganizerPayload{}
+ mi := &file_store_worksheet_proto_msgTypes[0]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *WorkSheetOrganizerPayload) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*WorkSheetOrganizerPayload) ProtoMessage() {}
+
+func (x *WorkSheetOrganizerPayload) ProtoReflect() protoreflect.Message {
+ mi := &file_store_worksheet_proto_msgTypes[0]
+ if x != nil {
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ if ms.LoadMessageInfo() == nil {
+ ms.StoreMessageInfo(mi)
+ }
+ return ms
+ }
+ return mi.MessageOf(x)
+}
+
+// Deprecated: Use WorkSheetOrganizerPayload.ProtoReflect.Descriptor instead.
+func (*WorkSheetOrganizerPayload) Descriptor() ([]byte, []int) {
+ return file_store_worksheet_proto_rawDescGZIP(), []int{0}
+}
+
+func (x *WorkSheetOrganizerPayload) GetStarred() bool {
+ if x != nil {
+ return x.Starred
+ }
+ return false
+}
+
+func (x *WorkSheetOrganizerPayload) GetFolders() []string {
+ if x != nil {
+ return x.Folders
+ }
+ return nil
+}
+
+var File_store_worksheet_proto protoreflect.FileDescriptor
+
+const file_store_worksheet_proto_rawDesc = "" +
+ "\n" +
+ "\x15store/worksheet.proto\x12\x0ebytebase.store\"O\n" +
+ "\x19WorkSheetOrganizerPayload\x12\x18\n" +
+ "\astarred\x18\x01 \x01(\bR\astarred\x12\x18\n" +
+ "\afolders\x18\x02 \x03(\tR\afoldersB\x91\x01\n" +
+ "\x12com.bytebase.storeB\x0eWorksheetProtoP\x01Z\x12generated-go/store\xa2\x02\x03BSX\xaa\x02\x0eBytebase.Store\xca\x02\x0eBytebase\\Store\xe2\x02\x1aBytebase\\Store\\GPBMetadata\xea\x02\x0fBytebase::Storeb\x06proto3"
+
+var (
+ file_store_worksheet_proto_rawDescOnce sync.Once
+ file_store_worksheet_proto_rawDescData []byte
+)
+
+func file_store_worksheet_proto_rawDescGZIP() []byte {
+ file_store_worksheet_proto_rawDescOnce.Do(func() {
+ file_store_worksheet_proto_rawDescData = protoimpl.X.CompressGZIP(unsafe.Slice(unsafe.StringData(file_store_worksheet_proto_rawDesc), len(file_store_worksheet_proto_rawDesc)))
+ })
+ return file_store_worksheet_proto_rawDescData
+}
+
+var file_store_worksheet_proto_msgTypes = make([]protoimpl.MessageInfo, 1)
+var file_store_worksheet_proto_goTypes = []any{
+ (*WorkSheetOrganizerPayload)(nil), // 0: bytebase.store.WorkSheetOrganizerPayload
+}
+var file_store_worksheet_proto_depIdxs = []int32{
+ 0, // [0:0] is the sub-list for method output_type
+ 0, // [0:0] is the sub-list for method input_type
+ 0, // [0:0] is the sub-list for extension type_name
+ 0, // [0:0] is the sub-list for extension extendee
+ 0, // [0:0] is the sub-list for field type_name
+}
+
+func init() { file_store_worksheet_proto_init() }
+func file_store_worksheet_proto_init() {
+ if File_store_worksheet_proto != nil {
+ return
+ }
+ type x struct{}
+ out := protoimpl.TypeBuilder{
+ File: protoimpl.DescBuilder{
+ GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
+ RawDescriptor: unsafe.Slice(unsafe.StringData(file_store_worksheet_proto_rawDesc), len(file_store_worksheet_proto_rawDesc)),
+ NumEnums: 0,
+ NumMessages: 1,
+ NumExtensions: 0,
+ NumServices: 0,
+ },
+ GoTypes: file_store_worksheet_proto_goTypes,
+ DependencyIndexes: file_store_worksheet_proto_depIdxs,
+ MessageInfos: file_store_worksheet_proto_msgTypes,
+ }.Build()
+ File_store_worksheet_proto = out.File
+ file_store_worksheet_proto_goTypes = nil
+ file_store_worksheet_proto_depIdxs = nil
+}
diff --git a/backend/generated-go/store/worksheet_equal.pb.go b/backend/generated-go/store/worksheet_equal.pb.go
new file mode 100644
index 0000000000..caf879117e
--- /dev/null
+++ b/backend/generated-go/store/worksheet_equal.pb.go
@@ -0,0 +1,25 @@
+// Code generated by protoc-gen-equal-go. DO NOT EDIT.
+// source: store/worksheet.proto
+
+package store
+
+func (x *WorkSheetOrganizerPayload) Equal(y *WorkSheetOrganizerPayload) bool {
+ if x == y {
+ return true
+ }
+ if x == nil || y == nil {
+ return x == nil && y == nil
+ }
+ if x.Starred != y.Starred {
+ return false
+ }
+ if len(x.Folders) != len(y.Folders) {
+ return false
+ }
+ for i := 0; i < len(x.Folders); i++ {
+ if x.Folders[i] != y.Folders[i] {
+ return false
+ }
+ }
+ return true
+}
diff --git a/backend/generated-go/v1/worksheet_service.pb.go b/backend/generated-go/v1/worksheet_service.pb.go
index ab20a9dd86..141e2a1bdc 100644
--- a/backend/generated-go/v1/worksheet_service.pb.go
+++ b/backend/generated-go/v1/worksheet_service.pb.go
@@ -312,7 +312,8 @@ type WorksheetOrganizer struct {
// Format: worksheets/{worksheet}
Worksheet string `protobuf:"bytes,1,opt,name=worksheet,proto3" json:"worksheet,omitempty"`
// starred means if the worksheet is starred.
- Starred bool `protobuf:"varint,2,opt,name=starred,proto3" json:"starred,omitempty"`
+ Starred bool `protobuf:"varint,2,opt,name=starred,proto3" json:"starred,omitempty"`
+ Folders []string `protobuf:"bytes,3,rep,name=folders,proto3" json:"folders,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
@@ -361,6 +362,13 @@ func (x *WorksheetOrganizer) GetStarred() bool {
return false
}
+func (x *WorksheetOrganizer) GetFolders() []string {
+ if x != nil {
+ return x.Folders
+ }
+ return nil
+}
+
type DeleteWorksheetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// The name of the worksheet to delete.
@@ -541,7 +549,8 @@ type Worksheet struct {
ContentSize int64 `protobuf:"varint,9,opt,name=content_size,json=contentSize,proto3" json:"content_size,omitempty"`
Visibility Worksheet_Visibility `protobuf:"varint,10,opt,name=visibility,proto3,enum=bytebase.v1.Worksheet_Visibility" json:"visibility,omitempty"`
// starred indicates whether the worksheet is starred by the current authenticated user.
- Starred bool `protobuf:"varint,11,opt,name=starred,proto3" json:"starred,omitempty"`
+ Starred bool `protobuf:"varint,11,opt,name=starred,proto3" json:"starred,omitempty"`
+ Folders []string `protobuf:"bytes,12,rep,name=folders,proto3" json:"folders,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
}
@@ -653,6 +662,13 @@ func (x *Worksheet) GetStarred() bool {
return false
}
+func (x *Worksheet) GetFolders() []string {
+ if x != nil {
+ return x.Folders
+ }
+ return nil
+}
+
var File_v1_worksheet_service_proto protoreflect.FileDescriptor
const file_v1_worksheet_service_proto_rawDesc = "" +
@@ -670,10 +686,11 @@ const file_v1_worksheet_service_proto_rawDesc = "" +
"\torganizer\x18\x01 \x01(\v2\x1f.bytebase.v1.WorksheetOrganizerB\x03\xe0A\x02R\torganizer\x12;\n" +
"\vupdate_mask\x18\x02 \x01(\v2\x1a.google.protobuf.FieldMaskR\n" +
"updateMask\x12#\n" +
- "\rallow_missing\x18\x03 \x01(\bR\fallowMissing\"Q\n" +
+ "\rallow_missing\x18\x03 \x01(\bR\fallowMissing\"k\n" +
"\x12WorksheetOrganizer\x12!\n" +
"\tworksheet\x18\x01 \x01(\tB\x03\xe0A\x02R\tworksheet\x12\x18\n" +
- "\astarred\x18\x02 \x01(\bR\astarred\"1\n" +
+ "\astarred\x18\x02 \x01(\bR\astarred\x12\x18\n" +
+ "\afolders\x18\x03 \x03(\tR\afolders\"1\n" +
"\x16DeleteWorksheetRequest\x12\x17\n" +
"\x04name\x18\x01 \x01(\tB\x03\xe0A\x02R\x04name\"1\n" +
"\x17SearchWorksheetsRequest\x12\x16\n" +
@@ -681,7 +698,7 @@ const file_v1_worksheet_service_proto_rawDesc = "" +
"\x18SearchWorksheetsResponse\x126\n" +
"\n" +
"worksheets\x18\x01 \x03(\v2\x16.bytebase.v1.WorksheetR\n" +
- "worksheets\"\xb2\x04\n" +
+ "worksheets\"\xd1\x04\n" +
"\tWorksheet\x12\x1a\n" +
"\x04name\x18\x01 \x01(\tB\x06\xe0A\x02\xe0A\x05R\x04name\x12\x1d\n" +
"\aproject\x18\x02 \x01(\tB\x03\xe0A\x02R\aproject\x12\x1a\n" +
@@ -698,7 +715,8 @@ const file_v1_worksheet_service_proto_rawDesc = "" +
"visibility\x18\n" +
" \x01(\x0e2!.bytebase.v1.Worksheet.VisibilityB\x03\xe0A\x02R\n" +
"visibility\x12\x1d\n" +
- "\astarred\x18\v \x01(\bB\x03\xe0A\x03R\astarred\"Z\n" +
+ "\astarred\x18\v \x01(\bB\x03\xe0A\x03R\astarred\x12\x1d\n" +
+ "\afolders\x18\f \x03(\tB\x03\xe0A\x03R\afolders\"Z\n" +
"\n" +
"Visibility\x12\x1a\n" +
"\x16VISIBILITY_UNSPECIFIED\x10\x00\x12\x10\n" +
diff --git a/backend/generated-go/v1/worksheet_service_equal.pb.go b/backend/generated-go/v1/worksheet_service_equal.pb.go
index 6a97887d83..eaada32682 100644
--- a/backend/generated-go/v1/worksheet_service_equal.pb.go
+++ b/backend/generated-go/v1/worksheet_service_equal.pb.go
@@ -90,6 +90,14 @@ func (x *WorksheetOrganizer) Equal(y *WorksheetOrganizer) bool {
if x.Starred != y.Starred {
return false
}
+ if len(x.Folders) != len(y.Folders) {
+ return false
+ }
+ for i := 0; i < len(x.Folders); i++ {
+ if x.Folders[i] != y.Folders[i] {
+ return false
+ }
+ }
return true
}
@@ -177,5 +185,13 @@ func (x *Worksheet) Equal(y *Worksheet) bool {
if x.Starred != y.Starred {
return false
}
+ if len(x.Folders) != len(y.Folders) {
+ return false
+ }
+ for i := 0; i < len(x.Folders); i++ {
+ if x.Folders[i] != y.Folders[i] {
+ return false
+ }
+ }
return true
}
diff --git a/backend/migrator/migration/3.12/0004##add_category_to_worksheet_organizer.sql b/backend/migrator/migration/3.12/0004##add_category_to_worksheet_organizer.sql
new file mode 100644
index 0000000000..8de530e680
--- /dev/null
+++ b/backend/migrator/migration/3.12/0004##add_category_to_worksheet_organizer.sql
@@ -0,0 +1,16 @@
+-- Add payload column to worksheet_organizer table and migrate starred column into it
+--
+-- This migration adds a "payload" column to store additional data for worksheets,
+-- including the starred status and folders. The starred column is migrated into the payload.
+
+-- Add payload column with default empty object
+ALTER TABLE worksheet_organizer ADD COLUMN payload jsonb NOT NULL DEFAULT '{}';
+
+-- Migrate existing starred values into the payload
+UPDATE worksheet_organizer SET payload = jsonb_set(payload, '{starred}', to_jsonb(starred));
+
+-- Drop the starred column as it's now in the payload
+ALTER TABLE worksheet_organizer DROP COLUMN starred;
+
+-- Create GIN index on payload for efficient JSONB queries
+CREATE INDEX idx_worksheet_organizer_payload ON worksheet_organizer USING GIN(payload);
diff --git a/backend/migrator/migration/LATEST.sql b/backend/migrator/migration/LATEST.sql
index 3aa176f330..c90e82da5b 100644
--- a/backend/migrator/migration/LATEST.sql
+++ b/backend/migrator/migration/LATEST.sql
@@ -417,13 +417,15 @@ CREATE TABLE worksheet_organizer (
id serial PRIMARY KEY,
worksheet_id integer NOT NULL REFERENCES worksheet(id) ON DELETE CASCADE,
principal_id integer NOT NULL REFERENCES principal(id),
- starred boolean NOT NULL DEFAULT false
+ payload jsonb NOT NULL DEFAULT '{}'
);
CREATE UNIQUE INDEX idx_worksheet_organizer_unique_sheet_id_principal_id ON worksheet_organizer(worksheet_id, principal_id);
CREATE INDEX idx_worksheet_organizer_principal_id ON worksheet_organizer(principal_id);
+CREATE INDEX idx_worksheet_organizer_payload ON worksheet_organizer USING GIN(payload);
+
-- risk stores the definition of a risk.
CREATE TABLE risk (
id bigserial PRIMARY KEY,
diff --git a/backend/migrator/migrator_test.go b/backend/migrator/migrator_test.go
index 431f90f733..a6e2029a84 100644
--- a/backend/migrator/migrator_test.go
+++ b/backend/migrator/migrator_test.go
@@ -12,7 +12,7 @@ import (
func TestLatestVersion(t *testing.T) {
files, err := getSortedVersionedFiles()
require.NoError(t, err)
- require.Equal(t, semver.MustParse("3.12.3"), *files[len(files)-1].version)
+ require.Equal(t, semver.MustParse("3.12.4"), *files[len(files)-1].version)
}
func TestVersionUnique(t *testing.T) {
diff --git a/backend/store/worksheet.go b/backend/store/worksheet.go
index 99c0a617e8..d7d72ecb7e 100644
--- a/backend/store/worksheet.go
+++ b/backend/store/worksheet.go
@@ -51,6 +51,7 @@ type WorkSheetMessage struct {
CreatedAt time.Time
UpdatedAt time.Time
Starred bool
+ Folders []string
}
// FindWorkSheetMessage is the API message for finding sheets.
@@ -110,7 +111,7 @@ func (s *Store) ListWorkSheets(ctx context.Context, find *FindWorkSheetMessage,
%s,
worksheet.visibility,
OCTET_LENGTH(worksheet.statement),
- COALESCE(worksheet_organizer.starred, FALSE)
+ COALESCE(worksheet_organizer.payload, '{}')
FROM worksheet
LEFT JOIN worksheet_organizer ON worksheet_organizer.worksheet_id = worksheet.id AND worksheet_organizer.principal_id = %d
WHERE TRUE`, statementField, currentPrincipalID))
@@ -143,6 +144,7 @@ func (s *Store) ListWorkSheets(ctx context.Context, find *FindWorkSheetMessage,
var sheets []*WorkSheetMessage
for rows.Next() {
var sheet WorkSheetMessage
+ var payloadBytes []byte
if err := rows.Scan(
&sheet.UID,
&sheet.CreatorID,
@@ -155,11 +157,18 @@ func (s *Store) ListWorkSheets(ctx context.Context, find *FindWorkSheetMessage,
&sheet.Statement,
&sheet.Visibility,
&sheet.Size,
- &sheet.Starred,
+ &payloadBytes,
); err != nil {
return nil, err
}
+ var payload storepb.WorkSheetOrganizerPayload
+ if err := common.ProtojsonUnmarshaler.Unmarshal(payloadBytes, &payload); err != nil {
+ return nil, errors.Wrapf(err, "failed to unmarshal worksheet organizer payload")
+ }
+ sheet.Folders = payload.Folders
+ sheet.Starred = payload.Starred
+
sheets = append(sheets, &sheet)
}
if err := rows.Err(); err != nil {
@@ -305,28 +314,74 @@ type WorksheetOrganizerMessage struct {
// Related fields
WorksheetUID int
PrincipalUID int
- Starred bool
+ Payload *storepb.WorkSheetOrganizerPayload
+}
+
+func (s *Store) GetWorksheetOrganizer(ctx context.Context, worksheetUID, principalUID int) (*WorksheetOrganizerMessage, error) {
+ q := qb.Q().Space(`
+ SELECT
+ id,
+ payload
+ FROM worksheet_organizer
+ WHERE worksheet_id = ? AND principal_id = ?
+ `, worksheetUID, principalUID)
+
+ query, args, err := q.ToSQL()
+ if err != nil {
+ return nil, errors.Wrapf(err, "failed to build sql")
+ }
+
+ worksheetOrganizer := WorksheetOrganizerMessage{
+ WorksheetUID: worksheetUID,
+ PrincipalUID: principalUID,
+ Payload: &storepb.WorkSheetOrganizerPayload{},
+ }
+ var payload []byte
+ if err := s.GetDB().QueryRowContext(ctx, query, args...).Scan(
+ &worksheetOrganizer.UID,
+ &payload,
+ ); err != nil {
+ if err == sql.ErrNoRows {
+ return &worksheetOrganizer, nil
+ }
+ return nil, errors.Wrapf(err, "failed to scan")
+ }
+ workSheetPayload := &storepb.WorkSheetOrganizerPayload{}
+ if err := common.ProtojsonUnmarshaler.Unmarshal(payload, workSheetPayload); err != nil {
+ return nil, err
+ }
+ worksheetOrganizer.Payload = workSheetPayload
+
+ return &worksheetOrganizer, nil
}
// UpsertWorksheetOrganizer upserts a new SheetOrganizerMessage.
-func (s *Store) UpsertWorksheetOrganizer(ctx context.Context, organizer *WorksheetOrganizerMessage) (*WorksheetOrganizerMessage, error) {
+func (s *Store) UpsertWorksheetOrganizer(ctx context.Context, patch *WorksheetOrganizerMessage) (*WorksheetOrganizerMessage, error) {
tx, err := s.GetDB().BeginTx(ctx, nil)
if err != nil {
return nil, err
}
defer tx.Rollback()
+ payloadStr, err := protojson.Marshal(patch.Payload)
+ if err != nil {
+ return nil, err
+ }
q := qb.Q().Space(`
INSERT INTO worksheet_organizer (
worksheet_id,
principal_id,
- starred
+ payload
)
VALUES (?, ?, ?)
ON CONFLICT(worksheet_id, principal_id) DO UPDATE SET
- starred = EXCLUDED.starred
- RETURNING id, worksheet_id, principal_id, starred
- `, organizer.WorksheetUID, organizer.PrincipalUID, organizer.Starred)
+ payload = EXCLUDED.payload
+ RETURNING
+ id,
+ worksheet_id,
+ principal_id,
+ payload
+ `, patch.WorksheetUID, patch.PrincipalUID, payloadStr)
query, args, err := q.ToSQL()
if err != nil {
@@ -334,17 +389,23 @@ func (s *Store) UpsertWorksheetOrganizer(ctx context.Context, organizer *Workshe
}
var worksheetOrganizer WorksheetOrganizerMessage
+ var payload []byte
if err := tx.QueryRowContext(ctx, query, args...).Scan(
&worksheetOrganizer.UID,
&worksheetOrganizer.WorksheetUID,
&worksheetOrganizer.PrincipalUID,
- &worksheetOrganizer.Starred,
+ &payload,
); err != nil {
if err == sql.ErrNoRows {
return nil, common.FormatDBErrorEmptyRowWithQuery(query)
}
return nil, err
}
+ workSheetPayload := &storepb.WorkSheetOrganizerPayload{}
+ if err := common.ProtojsonUnmarshaler.Unmarshal(payload, workSheetPayload); err != nil {
+ return nil, err
+ }
+ worksheetOrganizer.Payload = workSheetPayload
if err := tx.Commit(); err != nil {
return nil, err
@@ -394,7 +455,7 @@ func GetListSheetFilter(ctx context.Context, s *Store, callerID int, filter stri
return qb.Q().Space("worksheet.creator_id = ?", userID), nil
case "starred":
if starred, ok := value.(bool); ok {
- return qb.Q().Space("worksheet.id IN (SELECT worksheet_id FROM worksheet_organizer WHERE principal_id = ? AND starred = ?)", callerID, starred), nil
+ return qb.Q().Space("worksheet.id IN (SELECT worksheet_id FROM worksheet_organizer WHERE principal_id = ? AND (payload->>'starred')::boolean = ?)", callerID, starred), nil
}
return qb.Q().Space("TRUE"), nil
case "visibility":
diff --git a/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts b/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts
index 14492ba4c4..4285b86c6e 100644
--- a/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts
@@ -140,6 +140,11 @@ export declare type WorksheetOrganizer = Message<"bytebase.v1.WorksheetOrganizer
* @generated from field: bool starred = 2;
*/
starred: boolean;
+
+ /**
+ * @generated from field: repeated string folders = 3;
+ */
+ folders: string[];
};
/**
@@ -303,6 +308,11 @@ export declare type Worksheet = Message<"bytebase.v1.Worksheet"> & {
* @generated from field: bool starred = 11;
*/
starred: boolean;
+
+ /**
+ * @generated from field: repeated string folders = 12;
+ */
+ folders: string[];
};
/**
diff --git a/frontend/src/types/proto-es/v1/worksheet_service_pb.js b/frontend/src/types/proto-es/v1/worksheet_service_pb.js
index 01ca0e5cbb..8ce81fa1b6 100644
--- a/frontend/src/types/proto-es/v1/worksheet_service_pb.js
+++ b/frontend/src/types/proto-es/v1/worksheet_service_pb.js
@@ -14,7 +14,7 @@ import { file_v1_annotation } from "./annotation_pb";
* Describes the file v1/worksheet_service.proto.
*/
export const file_v1_worksheet_service = /*@__PURE__*/
- fileDesc("Chp2MS93b3Jrc2hlZXRfc2VydmljZS5wcm90bxILYnl0ZWJhc2UudjEiSAoWQ3JlYXRlV29ya3NoZWV0UmVxdWVzdBIuCgl3b3Jrc2hlZXQYASABKAsyFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRCA+BBAiIoChNHZXRXb3Jrc2hlZXRSZXF1ZXN0EhEKBG5hbWUYASABKAlCA+BBAiJ5ChZVcGRhdGVXb3Jrc2hlZXRSZXF1ZXN0Ei4KCXdvcmtzaGVldBgBIAEoCzIWLmJ5dGViYXNlLnYxLldvcmtzaGVldEID4EECEi8KC3VwZGF0ZV9tYXNrGAIgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzayKiAQofVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVxdWVzdBI3Cglvcmdhbml6ZXIYASABKAsyHy5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRPcmdhbml6ZXJCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCI9ChJXb3Jrc2hlZXRPcmdhbml6ZXISFgoJd29ya3NoZWV0GAEgASgJQgPgQQISDwoHc3RhcnJlZBgCIAEoCCIrChZEZWxldGVXb3Jrc2hlZXRSZXF1ZXN0EhEKBG5hbWUYASABKAlCA+BBAiIpChdTZWFyY2hXb3Jrc2hlZXRzUmVxdWVzdBIOCgZmaWx0ZXIYASABKAkiRgoYU2VhcmNoV29ya3NoZWV0c1Jlc3BvbnNlEioKCndvcmtzaGVldHMYASADKAsyFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQixgMKCVdvcmtzaGVldBIUCgRuYW1lGAEgASgJQgbgQQLgQQUSFAoHcHJvamVjdBgCIAEoCUID4EECEhAKCGRhdGFiYXNlGAMgASgJEhoKBXRpdGxlGAQgASgJQgvgQQK6SAVyAxjIARIUCgdjcmVhdG9yGAUgASgJQgPgQQMSNAoLY3JlYXRlX3RpbWUYBiABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wQgPgQQMSNAoLdXBkYXRlX3RpbWUYByABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wQgPgQQMSFAoHY29udGVudBgIIAEoDEID4EECEhkKDGNvbnRlbnRfc2l6ZRgJIAEoA0ID4EEDEjoKCnZpc2liaWxpdHkYCiABKA4yIS5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQuVmlzaWJpbGl0eUID4EECEhQKB3N0YXJyZWQYCyABKAhCA+BBAyJaCgpWaXNpYmlsaXR5EhoKFlZJU0lCSUxJVFlfVU5TUEVDSUZJRUQQABIQCgxQUk9KRUNUX1JFQUQQARIRCg1QUk9KRUNUX1dSSVRFEAISCwoHUFJJVkFURRADMoAHChBXb3Jrc2hlZXRTZXJ2aWNlEoEBCg9DcmVhdGVXb3Jrc2hlZXQSIy5ieXRlYmFzZS52MS5DcmVhdGVXb3Jrc2hlZXRSZXF1ZXN0GhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0IjHaQQl3b3Jrc2hlZXSQ6jACgtPkkwIbOgl3b3Jrc2hlZXQiDi92MS93b3Jrc2hlZXRzEnQKDEdldFdvcmtzaGVldBIgLmJ5dGViYXNlLnYxLkdldFdvcmtzaGVldFJlcXVlc3QaFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQiKtpBBG5hbWWQ6jACgtPkkwIZEhcvdjEve25hbWU9d29ya3NoZWV0cy8qfRKFAQoQU2VhcmNoV29ya3NoZWV0cxIkLmJ5dGViYXNlLnYxLlNlYXJjaFdvcmtzaGVldHNSZXF1ZXN0GiUuYnl0ZWJhc2UudjEuU2VhcmNoV29ya3NoZWV0c1Jlc3BvbnNlIiSQ6jACgtPkkwIaOgEqIhUvdjEvd29ya3NoZWV0czpzZWFyY2gSoAEKD1VwZGF0ZVdvcmtzaGVldBIjLmJ5dGViYXNlLnYxLlVwZGF0ZVdvcmtzaGVldFJlcXVlc3QaFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQiUNpBFXdvcmtzaGVldCx1cGRhdGVfbWFza5DqMAKC0+STAi46CXdvcmtzaGVldDIhL3YxL3t3b3Jrc2hlZXQubmFtZT13b3Jrc2hlZXRzLyp9EsoBChhVcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXISLC5ieXRlYmFzZS52MS5VcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXJSZXF1ZXN0Gh8uYnl0ZWJhc2UudjEuV29ya3NoZWV0T3JnYW5pemVyIl/aQRVvcmdhbml6ZXIsdXBkYXRlX21hc2uQ6jACgtPkkwI9Oglvcmdhbml6ZXIyMC92MS97b3JnYW5pemVyLndvcmtzaGVldD13b3Jrc2hlZXRzLyp9L29yZ2FuaXplchJ6Cg9EZWxldGVXb3Jrc2hlZXQSIy5ieXRlYmFzZS52MS5EZWxldGVXb3Jrc2hlZXRSZXF1ZXN0GhYuZ29vZ2xlLnByb3RvYnVmLkVtcHR5IiraQQRuYW1lkOowAoLT5JMCGSoXL3YxL3tuYW1lPXdvcmtzaGVldHMvKn1CqwEKD2NvbS5ieXRlYmFzZS52MUIVV29ya3NoZWV0U2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation]);
+ fileDesc("Chp2MS93b3Jrc2hlZXRfc2VydmljZS5wcm90bxILYnl0ZWJhc2UudjEiSAoWQ3JlYXRlV29ya3NoZWV0UmVxdWVzdBIuCgl3b3Jrc2hlZXQYASABKAsyFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRCA+BBAiIoChNHZXRXb3Jrc2hlZXRSZXF1ZXN0EhEKBG5hbWUYASABKAlCA+BBAiJ5ChZVcGRhdGVXb3Jrc2hlZXRSZXF1ZXN0Ei4KCXdvcmtzaGVldBgBIAEoCzIWLmJ5dGViYXNlLnYxLldvcmtzaGVldEID4EECEi8KC3VwZGF0ZV9tYXNrGAIgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFzayKiAQofVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVxdWVzdBI3Cglvcmdhbml6ZXIYASABKAsyHy5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRPcmdhbml6ZXJCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJOChJXb3Jrc2hlZXRPcmdhbml6ZXISFgoJd29ya3NoZWV0GAEgASgJQgPgQQISDwoHc3RhcnJlZBgCIAEoCBIPCgdmb2xkZXJzGAMgAygJIisKFkRlbGV0ZVdvcmtzaGVldFJlcXVlc3QSEQoEbmFtZRgBIAEoCUID4EECIikKF1NlYXJjaFdvcmtzaGVldHNSZXF1ZXN0Eg4KBmZpbHRlchgBIAEoCSJGChhTZWFyY2hXb3Jrc2hlZXRzUmVzcG9uc2USKgoKd29ya3NoZWV0cxgBIAMoCzIWLmJ5dGViYXNlLnYxLldvcmtzaGVldCLcAwoJV29ya3NoZWV0EhQKBG5hbWUYASABKAlCBuBBAuBBBRIUCgdwcm9qZWN0GAIgASgJQgPgQQISEAoIZGF0YWJhc2UYAyABKAkSGgoFdGl0bGUYBCABKAlCC+BBArpIBXIDGMgBEhQKB2NyZWF0b3IYBSABKAlCA+BBAxI0CgtjcmVhdGVfdGltZRgGIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCA+BBAxI0Cgt1cGRhdGVfdGltZRgHIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCA+BBAxIUCgdjb250ZW50GAggASgMQgPgQQISGQoMY29udGVudF9zaXplGAkgASgDQgPgQQMSOgoKdmlzaWJpbGl0eRgKIAEoDjIhLmJ5dGViYXNlLnYxLldvcmtzaGVldC5WaXNpYmlsaXR5QgPgQQISFAoHc3RhcnJlZBgLIAEoCEID4EEDEhQKB2ZvbGRlcnMYDCADKAlCA+BBAyJaCgpWaXNpYmlsaXR5EhoKFlZJU0lCSUxJVFlfVU5TUEVDSUZJRUQQABIQCgxQUk9KRUNUX1JFQUQQARIRCg1QUk9KRUNUX1dSSVRFEAISCwoHUFJJVkFURRADMoAHChBXb3Jrc2hlZXRTZXJ2aWNlEoEBCg9DcmVhdGVXb3Jrc2hlZXQSIy5ieXRlYmFzZS52MS5DcmVhdGVXb3Jrc2hlZXRSZXF1ZXN0GhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0IjHaQQl3b3Jrc2hlZXSQ6jACgtPkkwIbOgl3b3Jrc2hlZXQiDi92MS93b3Jrc2hlZXRzEnQKDEdldFdvcmtzaGVldBIgLmJ5dGViYXNlLnYxLkdldFdvcmtzaGVldFJlcXVlc3QaFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQiKtpBBG5hbWWQ6jACgtPkkwIZEhcvdjEve25hbWU9d29ya3NoZWV0cy8qfRKFAQoQU2VhcmNoV29ya3NoZWV0cxIkLmJ5dGViYXNlLnYxLlNlYXJjaFdvcmtzaGVldHNSZXF1ZXN0GiUuYnl0ZWJhc2UudjEuU2VhcmNoV29ya3NoZWV0c1Jlc3BvbnNlIiSQ6jACgtPkkwIaOgEqIhUvdjEvd29ya3NoZWV0czpzZWFyY2gSoAEKD1VwZGF0ZVdvcmtzaGVldBIjLmJ5dGViYXNlLnYxLlVwZGF0ZVdvcmtzaGVldFJlcXVlc3QaFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQiUNpBFXdvcmtzaGVldCx1cGRhdGVfbWFza5DqMAKC0+STAi46CXdvcmtzaGVldDIhL3YxL3t3b3Jrc2hlZXQubmFtZT13b3Jrc2hlZXRzLyp9EsoBChhVcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXISLC5ieXRlYmFzZS52MS5VcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXJSZXF1ZXN0Gh8uYnl0ZWJhc2UudjEuV29ya3NoZWV0T3JnYW5pemVyIl/aQRVvcmdhbml6ZXIsdXBkYXRlX21hc2uQ6jACgtPkkwI9Oglvcmdhbml6ZXIyMC92MS97b3JnYW5pemVyLndvcmtzaGVldD13b3Jrc2hlZXRzLyp9L29yZ2FuaXplchJ6Cg9EZWxldGVXb3Jrc2hlZXQSIy5ieXRlYmFzZS52MS5EZWxldGVXb3Jrc2hlZXRSZXF1ZXN0GhYuZ29vZ2xlLnByb3RvYnVmLkVtcHR5IiraQQRuYW1lkOowAoLT5JMCGSoXL3YxL3tuYW1lPXdvcmtzaGVldHMvKn1CqwEKD2NvbS5ieXRlYmFzZS52MUIVV29ya3NoZWV0U2VydmljZVByb3RvUAFaNGdpdGh1Yi5jb20vYnl0ZWJhc2UvYnl0ZWJhc2UvYmFja2VuZC9nZW5lcmF0ZWQtZ28vdjGiAgNCWFiqAgtCeXRlYmFzZS5WMcoCC0J5dGViYXNlXFYx4gIXQnl0ZWJhc2VcVjFcR1BCTWV0YWRhdGHqAgxCeXRlYmFzZTo6VjFiBnByb3RvMw", [file_buf_validate_validate, file_google_api_annotations, file_google_api_client, file_google_api_field_behavior, file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp, file_v1_annotation]);
/**
* Describes the message bytebase.v1.CreateWorksheetRequest.
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index 25605c6170..d79df01d25 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -14657,6 +14657,11 @@ components:
readOnly: true
type: boolean
description: starred indicates whether the worksheet is starred by the current authenticated user.
+ folders:
+ readOnly: true
+ type: array
+ items:
+ type: string
WorksheetOrganizer:
required:
- worksheet
@@ -14670,6 +14675,10 @@ components:
starred:
type: boolean
description: starred means if the worksheet is starred.
+ folders:
+ type: array
+ items:
+ type: string
WorkspaceApprovalSetting:
type: object
properties:
diff --git a/proto/gen/grpc-doc/store/README.md b/proto/gen/grpc-doc/store/README.md
index faf37dd344..9a33c39e7d 100644
--- a/proto/gen/grpc-doc/store/README.md
+++ b/proto/gen/grpc-doc/store/README.md
@@ -331,6 +331,9 @@
- [PrincipalType](#bytebase-store-PrincipalType)
+- [store/worksheet.proto](#store_worksheet-proto)
+ - [WorkSheetOrganizerPayload](#bytebase-store-WorkSheetOrganizerPayload)
+
- [Scalar Value Types](#scalar-value-types)
@@ -5243,6 +5246,38 @@ PrincipalType is the type of a principal.
+<a name="store_worksheet-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## store/worksheet.proto
+
+
+
+<a name="bytebase-store-WorkSheetOrganizerPayload"></a>
+
+### WorkSheetOrganizerPayload
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| starred | [bool](#bool) | | |
+| folders | [string](#string) | repeated | The folder path for a worksheet. For example, if the folders is [A, B, C], means the worksheet is in the A/B/C subfolder. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
## Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
diff --git a/proto/gen/grpc-doc/store/index.html b/proto/gen/grpc-doc/store/index.html
index 5f6fafd186..9560b64668 100644
--- a/proto/gen/grpc-doc/store/index.html
+++ b/proto/gen/grpc-doc/store/index.html
@@ -1493,6 +1493,21 @@
+ </ul>
+ </li>
+
+
+ <li>
+ <a href="#store%2fworksheet.proto">store/worksheet.proto</a>
+ <ul>
+
+ <li>
+ <a href="#bytebase.store.WorkSheetOrganizerPayload"><span class="badge">M</span>WorkSheetOrganizerPayload</a>
+ </li>
+
+
+
+
</ul>
</li>
@@ -13608,6 +13623,52 @@ The indexes of the executed commands. </p></td>
+
+ <div class="file-heading">
+ <h2 id="store/worksheet.proto">store/worksheet.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.store.WorkSheetOrganizerPayload">WorkSheetOrganizerPayload</h3>
+ <p></p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>starred</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>folders</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The folder path for a worksheet.
+For example, if the folders is [A, B, C], means the worksheet is in the A/B/C subfolder. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+
+
+
+
+
+
+
<h2 id="scalar-value-types">Scalar Value Types</h2>
<table class="scalar-value-types-table">
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index c999454996..40b82e3200 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -11037,6 +11037,7 @@ The worksheet&#39;s `name` field is used to identify the worksheet to update. Fo
| content_size | [int64](#int64) | | content_size is the full size of the content, may not match the size of the `content` field. |
| visibility | [Worksheet.Visibility](#bytebase-v1-Worksheet-Visibility) | | |
| starred | [bool](#bool) | | starred indicates whether the worksheet is starred by the current authenticated user. |
+| folders | [string](#string) | repeated | |
@@ -11053,6 +11054,7 @@ The worksheet&#39;s `name` field is used to identify the worksheet to update. Fo
| ----- | ---- | ----- | ----------- |
| worksheet | [string](#string) | | The name of the worksheet. Format: worksheets/{worksheet} |
| starred | [bool](#bool) | | starred means if the worksheet is starred. |
+| folders | [string](#string) | repeated | |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index f06790a7fb..b3eaa35954 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -30808,6 +30808,13 @@ use GetWorksheet() request to retrieve the full content. </p></td>
<td><p>starred indicates whether the worksheet is starred by the current authenticated user. </p></td>
</tr>
+ <tr>
+ <td>folders</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
</tbody>
</table>
@@ -30840,6 +30847,13 @@ Format: worksheets/{worksheet} </p></td>
<td><p>starred means if the worksheet is starred. </p></td>
</tr>
+ <tr>
+ <td>folders</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
</tbody>
</table>
diff --git a/proto/store/store/worksheet.proto b/proto/store/store/worksheet.proto
new file mode 100644
index 0000000000..bdb086e698
--- /dev/null
+++ b/proto/store/store/worksheet.proto
@@ -0,0 +1,12 @@
+syntax = "proto3";
+
+package bytebase.store;
+
+option go_package = "generated-go/store";
+
+message WorkSheetOrganizerPayload {
+ bool starred = 1;
+ // The folder path for a worksheet.
+ // For example, if the folders is [A, B, C], means the worksheet is in the A/B/C subfolder.
+ repeated string folders = 2;
+}
diff --git a/proto/v1/v1/worksheet_service.proto b/proto/v1/v1/worksheet_service.proto
index 5c8702b8aa..8d704eca54 100644
--- a/proto/v1/v1/worksheet_service.proto
+++ b/proto/v1/v1/worksheet_service.proto
@@ -141,6 +141,8 @@ message WorksheetOrganizer {
// starred means if the worksheet is starred.
bool starred = 2;
+
+ repeated string folders = 3;
}
message DeleteWorksheetRequest {
@@ -228,4 +230,6 @@ message Worksheet {
// starred indicates whether the worksheet is starred by the current authenticated user.
bool starred = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ repeated string folders = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
}