Skip to content

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

refactor: rename worksheet to saved query across API, backend, and frontend (#21159)

Danny Xu8d5d0b66cc39
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yaml
index 4956141a3b..cbec2be7db 100644
--- a/backend/api/mcp/gen/openapi.yaml
+++ b/backend/api/mcp/gen/openapi.yaml
@@ -5769,16 +5769,16 @@ paths:
schema:
$ref: '#/components/schemas/bytebase.v1.SearchQueryHistoriesResponse'
deprecated: true
- /bytebase.v1.ServiceAccountService/CreateServiceAccount:
+ /bytebase.v1.SavedQueryService/BatchUpdateSavedQueryOrganizer:
post:
tags:
- - bytebase.v1.ServiceAccountService
- summary: CreateServiceAccount
+ - bytebase.v1.SavedQueryService
+ summary: BatchUpdateSavedQueryOrganizer
description: |-
- Creates a new service account.
- For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.create on workspace.
- For project-level: parent is projects/{project}, permission bb.serviceAccounts.create on project.
- operationId: bytebase.v1.ServiceAccountService.CreateServiceAccount
+ Batch update the organizers of saved queries.
+ The access is the same as UpdateSavedQuery method.
+ Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ operationId: bytebase.v1.SavedQueryService.BatchUpdateSavedQueryOrganizer
parameters:
- name: Connect-Protocol-Version
in: header
@@ -5793,7 +5793,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.CreateServiceAccountRequest'
+ $ref: '#/components/schemas/bytebase.v1.BatchUpdateSavedQueryOrganizerRequest'
required: true
responses:
default:
@@ -5807,16 +5807,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
- /bytebase.v1.ServiceAccountService/DeleteServiceAccount:
+ $ref: '#/components/schemas/bytebase.v1.BatchUpdateSavedQueryOrganizerResponse'
+ /bytebase.v1.SavedQueryService/CreateSavedQuery:
post:
tags:
- - bytebase.v1.ServiceAccountService
- summary: DeleteServiceAccount
+ - bytebase.v1.SavedQueryService
+ summary: CreateSavedQuery
description: |-
- Deletes a service account.
- Permissions required: bb.serviceAccounts.delete
- operationId: bytebase.v1.ServiceAccountService.DeleteServiceAccount
+ Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries.
+ Permissions required: None (authenticated users only)
+ operationId: bytebase.v1.SavedQueryService.CreateSavedQuery
parameters:
- name: Connect-Protocol-Version
in: header
@@ -5831,7 +5831,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.DeleteServiceAccountRequest'
+ $ref: '#/components/schemas/bytebase.v1.CreateSavedQueryRequest'
required: true
responses:
default:
@@ -5845,16 +5845,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/google.protobuf.Empty'
- /bytebase.v1.ServiceAccountService/GetServiceAccount:
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ /bytebase.v1.SavedQueryService/DeleteSavedQuery:
post:
tags:
- - bytebase.v1.ServiceAccountService
- summary: GetServiceAccount
+ - bytebase.v1.SavedQueryService
+ summary: DeleteSavedQuery
description: |-
- Gets a service account by name.
- Permissions required: bb.serviceAccounts.get
- operationId: bytebase.v1.ServiceAccountService.GetServiceAccount
+ Delete a saved query.
+ The access is the same as UpdateSavedQuery method.
+ Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ operationId: bytebase.v1.SavedQueryService.DeleteSavedQuery
parameters:
- name: Connect-Protocol-Version
in: header
@@ -5869,7 +5870,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.GetServiceAccountRequest'
+ $ref: '#/components/schemas/bytebase.v1.DeleteSavedQueryRequest'
required: true
responses:
default:
@@ -5883,17 +5884,20 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
- /bytebase.v1.ServiceAccountService/ListServiceAccounts:
+ $ref: '#/components/schemas/google.protobuf.Empty'
+ /bytebase.v1.SavedQueryService/GetSavedQuery:
post:
tags:
- - bytebase.v1.ServiceAccountService
- summary: ListServiceAccounts
+ - bytebase.v1.SavedQueryService
+ summary: GetSavedQuery
description: |-
- Lists service accounts.
- For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.list on workspace.
- For project-level: parent is projects/{project}, permission bb.serviceAccounts.list on project.
- operationId: bytebase.v1.ServiceAccountService.ListServiceAccounts
+ Get a saved query by name.
+ The users can access this method if,
+ - they are the creator of the saved query;
+ - they have bb.worksheets.get permission on the workspace;
+ - the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ operationId: bytebase.v1.SavedQueryService.GetSavedQuery
parameters:
- name: Connect-Protocol-Version
in: header
@@ -5908,7 +5912,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListServiceAccountsRequest'
+ $ref: '#/components/schemas/bytebase.v1.GetSavedQueryRequest'
required: true
responses:
default:
@@ -5922,16 +5926,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListServiceAccountsResponse'
- /bytebase.v1.ServiceAccountService/UndeleteServiceAccount:
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ /bytebase.v1.SavedQueryService/ListSavedQueries:
post:
tags:
- - bytebase.v1.ServiceAccountService
- summary: UndeleteServiceAccount
+ - bytebase.v1.SavedQueryService
+ summary: ListSavedQueries
description: |-
- Restores a deleted service account.
- Permissions required: bb.serviceAccounts.undelete
- operationId: bytebase.v1.ServiceAccountService.UndeleteServiceAccount
+ List saved queries.
+ This is used for listing saved queries in a project, or across all projects by using `projects/-`.
+ Permissions required: bb.worksheets.list
+ operationId: bytebase.v1.SavedQueryService.ListSavedQueries
parameters:
- name: Connect-Protocol-Version
in: header
@@ -5946,7 +5951,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UndeleteServiceAccountRequest'
+ $ref: '#/components/schemas/bytebase.v1.ListSavedQueriesRequest'
required: true
responses:
default:
@@ -5960,16 +5965,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
- /bytebase.v1.ServiceAccountService/UpdateServiceAccount:
+ $ref: '#/components/schemas/bytebase.v1.ListSavedQueriesResponse'
+ /bytebase.v1.SavedQueryService/ListSavedQueryFolders:
post:
tags:
- - bytebase.v1.ServiceAccountService
- summary: UpdateServiceAccount
+ - bytebase.v1.SavedQueryService
+ summary: ListSavedQueryFolders
description: |-
- Updates a service account.
- Permissions required: bb.serviceAccounts.update
- operationId: bytebase.v1.ServiceAccountService.UpdateServiceAccount
+ List the caller's saved query folders.
+ Only folders stored in the caller's saved query organizer are returned.
+ operationId: bytebase.v1.SavedQueryService.ListSavedQueryFolders
parameters:
- name: Connect-Protocol-Version
in: header
@@ -5984,7 +5989,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UpdateServiceAccountRequest'
+ $ref: '#/components/schemas/bytebase.v1.ListSavedQueryFoldersRequest'
required: true
responses:
default:
@@ -5998,16 +6003,18 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
- /bytebase.v1.SettingService/GetSetting:
+ $ref: '#/components/schemas/bytebase.v1.ListSavedQueryFoldersResponse'
+ /bytebase.v1.SavedQueryService/SearchSavedQueries:
post:
tags:
- - bytebase.v1.SettingService
- summary: GetSetting
+ - bytebase.v1.SavedQueryService
+ summary: SearchSavedQueries
description: |-
- Retrieves a workspace setting by name.
- Permissions required: bb.settings.get
- operationId: bytebase.v1.SettingService.GetSetting
+ Search for saved queries.
+ This is used for finding my saved queries or saved queries shared by other people.
+ The saved query accessibility is the same as GetSavedQuery().
+ Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ operationId: bytebase.v1.SavedQueryService.SearchSavedQueries
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6022,7 +6029,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.GetSettingRequest'
+ $ref: '#/components/schemas/bytebase.v1.SearchSavedQueriesRequest'
required: true
responses:
default:
@@ -6036,16 +6043,20 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Setting'
- /bytebase.v1.SettingService/ListSettings:
+ $ref: '#/components/schemas/bytebase.v1.SearchSavedQueriesResponse'
+ /bytebase.v1.SavedQueryService/UpdateSavedQuery:
post:
tags:
- - bytebase.v1.SettingService
- summary: ListSettings
+ - bytebase.v1.SavedQueryService
+ summary: UpdateSavedQuery
description: |-
- Lists all workspace settings.
- Permissions required: bb.settings.list
- operationId: bytebase.v1.SettingService.ListSettings
+ Update a saved query.
+ The users can access this method if,
+ - they are the creator of the saved query;
+ - they have bb.worksheets.manage permission on the workspace;
+ - the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ operationId: bytebase.v1.SavedQueryService.UpdateSavedQuery
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6060,7 +6071,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListSettingsRequest'
+ $ref: '#/components/schemas/bytebase.v1.UpdateSavedQueryRequest'
required: true
responses:
default:
@@ -6074,16 +6085,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListSettingsResponse'
- /bytebase.v1.SettingService/TestEmailSetting:
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ /bytebase.v1.SavedQueryService/UpdateSavedQueryOrganizer:
post:
tags:
- - bytebase.v1.SettingService
- summary: TestEmailSetting
+ - bytebase.v1.SavedQueryService
+ summary: UpdateSavedQueryOrganizer
description: |-
- Sends a test email using the provided config (without persisting).
- Permissions required: bb.settings.set
- operationId: bytebase.v1.SettingService.TestEmailSetting
+ Update the organizer of a saved query.
+ The access is the same as UpdateSavedQuery method.
+ Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ operationId: bytebase.v1.SavedQueryService.UpdateSavedQueryOrganizer
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6098,7 +6110,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.TestEmailSettingRequest'
+ $ref: '#/components/schemas/bytebase.v1.UpdateSavedQueryOrganizerRequest'
required: true
responses:
default:
@@ -6112,16 +6124,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.TestEmailSettingResponse'
- /bytebase.v1.SettingService/UpdateSetting:
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
+ /bytebase.v1.ServiceAccountService/CreateServiceAccount:
post:
tags:
- - bytebase.v1.SettingService
- summary: UpdateSetting
+ - bytebase.v1.ServiceAccountService
+ summary: CreateServiceAccount
description: |-
- Updates a workspace setting.
- Permissions required: bb.settings.set
- operationId: bytebase.v1.SettingService.UpdateSetting
+ Creates a new service account.
+ For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.create on workspace.
+ For project-level: parent is projects/{project}, permission bb.serviceAccounts.create on project.
+ operationId: bytebase.v1.ServiceAccountService.CreateServiceAccount
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6136,7 +6149,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UpdateSettingRequest'
+ $ref: '#/components/schemas/bytebase.v1.CreateServiceAccountRequest'
required: true
responses:
default:
@@ -6150,16 +6163,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Setting'
- /bytebase.v1.SheetService/BatchCreateSheets:
+ $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
+ /bytebase.v1.ServiceAccountService/DeleteServiceAccount:
post:
tags:
- - bytebase.v1.SheetService
- summary: BatchCreateSheets
+ - bytebase.v1.ServiceAccountService
+ summary: DeleteServiceAccount
description: |-
- Creates multiple SQL sheets in a single operation.
- Permissions required: bb.sheets.create
- operationId: bytebase.v1.SheetService.BatchCreateSheets
+ Deletes a service account.
+ Permissions required: bb.serviceAccounts.delete
+ operationId: bytebase.v1.ServiceAccountService.DeleteServiceAccount
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6174,7 +6187,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.BatchCreateSheetsRequest'
+ $ref: '#/components/schemas/bytebase.v1.DeleteServiceAccountRequest'
required: true
responses:
default:
@@ -6188,16 +6201,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.BatchCreateSheetsResponse'
- /bytebase.v1.SheetService/CreateSheet:
+ $ref: '#/components/schemas/google.protobuf.Empty'
+ /bytebase.v1.ServiceAccountService/GetServiceAccount:
post:
tags:
- - bytebase.v1.SheetService
- summary: CreateSheet
+ - bytebase.v1.ServiceAccountService
+ summary: GetServiceAccount
description: |-
- Creates a new SQL sheet.
- Permissions required: bb.sheets.create
- operationId: bytebase.v1.SheetService.CreateSheet
+ Gets a service account by name.
+ Permissions required: bb.serviceAccounts.get
+ operationId: bytebase.v1.ServiceAccountService.GetServiceAccount
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6212,7 +6225,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.CreateSheetRequest'
+ $ref: '#/components/schemas/bytebase.v1.GetServiceAccountRequest'
required: true
responses:
default:
@@ -6226,16 +6239,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Sheet'
- /bytebase.v1.SheetService/GetSheet:
+ $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
+ /bytebase.v1.ServiceAccountService/ListServiceAccounts:
post:
tags:
- - bytebase.v1.SheetService
- summary: GetSheet
+ - bytebase.v1.ServiceAccountService
+ summary: ListServiceAccounts
description: |-
- Retrieves a SQL sheet by name.
- Permissions required: bb.sheets.get
- operationId: bytebase.v1.SheetService.GetSheet
+ Lists service accounts.
+ For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.list on workspace.
+ For project-level: parent is projects/{project}, permission bb.serviceAccounts.list on project.
+ operationId: bytebase.v1.ServiceAccountService.ListServiceAccounts
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6250,7 +6264,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.GetSheetRequest'
+ $ref: '#/components/schemas/bytebase.v1.ListServiceAccountsRequest'
required: true
responses:
default:
@@ -6264,14 +6278,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Sheet'
- /bytebase.v1.SubscriptionService/CancelPurchase:
+ $ref: '#/components/schemas/bytebase.v1.ListServiceAccountsResponse'
+ /bytebase.v1.ServiceAccountService/UndeleteServiceAccount:
post:
tags:
- - bytebase.v1.SubscriptionService
- summary: CancelPurchase
- description: CancelPurchase cancels an active subscription (SaaS only).
- operationId: bytebase.v1.SubscriptionService.CancelPurchase
+ - bytebase.v1.ServiceAccountService
+ summary: UndeleteServiceAccount
+ description: |-
+ Restores a deleted service account.
+ Permissions required: bb.serviceAccounts.undelete
+ operationId: bytebase.v1.ServiceAccountService.UndeleteServiceAccount
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6286,7 +6302,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.CancelPurchaseRequest'
+ $ref: '#/components/schemas/bytebase.v1.UndeleteServiceAccountRequest'
required: true
responses:
default:
@@ -6300,16 +6316,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.PurchaseResponse'
- /bytebase.v1.SubscriptionService/CreatePurchase:
+ $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
+ /bytebase.v1.ServiceAccountService/UpdateServiceAccount:
post:
tags:
- - bytebase.v1.SubscriptionService
- summary: CreatePurchase
+ - bytebase.v1.ServiceAccountService
+ summary: UpdateServiceAccount
description: |-
- CreatePurchase creates a new subscription purchase (SaaS only).
- Returns a Stripe Checkout URL for the user to complete payment.
- operationId: bytebase.v1.SubscriptionService.CreatePurchase
+ Updates a service account.
+ Permissions required: bb.serviceAccounts.update
+ operationId: bytebase.v1.ServiceAccountService.UpdateServiceAccount
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6324,7 +6340,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.CreatePurchaseRequest'
+ $ref: '#/components/schemas/bytebase.v1.UpdateServiceAccountRequest'
required: true
responses:
default:
@@ -6338,14 +6354,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.PurchaseResponse'
- /bytebase.v1.SubscriptionService/ExportVCSProviderUsers:
+ $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
+ /bytebase.v1.SettingService/GetSetting:
post:
tags:
- - bytebase.v1.SubscriptionService
- summary: ExportVCSProviderUsers
- description: Exports active VCS users as CSV.
- operationId: bytebase.v1.SubscriptionService.ExportVCSProviderUsers
+ - bytebase.v1.SettingService
+ summary: GetSetting
+ description: |-
+ Retrieves a workspace setting by name.
+ Permissions required: bb.settings.get
+ operationId: bytebase.v1.SettingService.GetSetting
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6360,7 +6378,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ExportVCSProviderUsersRequest'
+ $ref: '#/components/schemas/bytebase.v1.GetSettingRequest'
required: true
responses:
default:
@@ -6374,14 +6392,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/google.api.HttpBody'
- /bytebase.v1.SubscriptionService/GetPaymentInfo:
+ $ref: '#/components/schemas/bytebase.v1.Setting'
+ /bytebase.v1.SettingService/ListSettings:
post:
tags:
- - bytebase.v1.SubscriptionService
- summary: GetPaymentInfo
- description: GetPaymentInfo returns payment details for the current subscription (SaaS only).
- operationId: bytebase.v1.SubscriptionService.GetPaymentInfo
+ - bytebase.v1.SettingService
+ summary: ListSettings
+ description: |-
+ Lists all workspace settings.
+ Permissions required: bb.settings.list
+ operationId: bytebase.v1.SettingService.ListSettings
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6396,7 +6416,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.GetPaymentInfoRequest'
+ $ref: '#/components/schemas/bytebase.v1.ListSettingsRequest'
required: true
responses:
default:
@@ -6410,17 +6430,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.PaymentInfo'
- /bytebase.v1.SubscriptionService/GetSubscription:
+ $ref: '#/components/schemas/bytebase.v1.ListSettingsResponse'
+ /bytebase.v1.SettingService/TestEmailSetting:
post:
tags:
- - bytebase.v1.SubscriptionService
- summary: GetSubscription
+ - bytebase.v1.SettingService
+ summary: TestEmailSetting
description: |-
- GetSubscription returns the current subscription.
- If there is no license, we will return a free plan subscription without expiration time.
- If there is expired license, we will return a free plan subscription with the expiration time of the expired license.
- operationId: bytebase.v1.SubscriptionService.GetSubscription
+ Sends a test email using the provided config (without persisting).
+ Permissions required: bb.settings.set
+ operationId: bytebase.v1.SettingService.TestEmailSetting
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6435,7 +6454,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.GetSubscriptionRequest'
+ $ref: '#/components/schemas/bytebase.v1.TestEmailSettingRequest'
required: true
responses:
default:
@@ -6449,14 +6468,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Subscription'
- /bytebase.v1.SubscriptionService/ListPurchasePlans:
+ $ref: '#/components/schemas/bytebase.v1.TestEmailSettingResponse'
+ /bytebase.v1.SettingService/UpdateSetting:
post:
tags:
- - bytebase.v1.SubscriptionService
- summary: ListPurchasePlans
- description: ListPurchasePlans returns available plans for self-service purchase.
- operationId: bytebase.v1.SubscriptionService.ListPurchasePlans
+ - bytebase.v1.SettingService
+ summary: UpdateSetting
+ description: |-
+ Updates a workspace setting.
+ Permissions required: bb.settings.set
+ operationId: bytebase.v1.SettingService.UpdateSetting
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6471,7 +6492,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListPurchasePlansRequest'
+ $ref: '#/components/schemas/bytebase.v1.UpdateSettingRequest'
required: true
responses:
default:
@@ -6485,16 +6506,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListPurchasePlansResponse'
- /bytebase.v1.SubscriptionService/UpdatePurchase:
+ $ref: '#/components/schemas/bytebase.v1.Setting'
+ /bytebase.v1.SheetService/BatchCreateSheets:
post:
tags:
- - bytebase.v1.SubscriptionService
- summary: UpdatePurchase
+ - bytebase.v1.SheetService
+ summary: BatchCreateSheets
description: |-
- UpdatePurchase updates an existing subscription (SaaS only).
- May return a Stripe Checkout URL if payment method change is needed.
- operationId: bytebase.v1.SubscriptionService.UpdatePurchase
+ Creates multiple SQL sheets in a single operation.
+ Permissions required: bb.sheets.create
+ operationId: bytebase.v1.SheetService.BatchCreateSheets
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6509,7 +6530,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UpdatePurchaseRequest'
+ $ref: '#/components/schemas/bytebase.v1.BatchCreateSheetsRequest'
required: true
responses:
default:
@@ -6523,14 +6544,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.PurchaseResponse'
- /bytebase.v1.SubscriptionService/UploadLicense:
+ $ref: '#/components/schemas/bytebase.v1.BatchCreateSheetsResponse'
+ /bytebase.v1.SheetService/CreateSheet:
post:
tags:
- - bytebase.v1.SubscriptionService
- summary: UploadLicense
- description: Uploads an enterprise license (self-hosted only).
- operationId: bytebase.v1.SubscriptionService.UploadLicense
+ - bytebase.v1.SheetService
+ summary: CreateSheet
+ description: |-
+ Creates a new SQL sheet.
+ Permissions required: bb.sheets.create
+ operationId: bytebase.v1.SheetService.CreateSheet
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6545,7 +6568,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UploadLicenseRequest'
+ $ref: '#/components/schemas/bytebase.v1.CreateSheetRequest'
required: true
responses:
default:
@@ -6559,14 +6582,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Subscription'
- /bytebase.v1.SubscriptionService/VerifyCheckoutSession:
+ $ref: '#/components/schemas/bytebase.v1.Sheet'
+ /bytebase.v1.SheetService/GetSheet:
post:
tags:
- - bytebase.v1.SubscriptionService
- summary: VerifyCheckoutSession
- description: VerifyCheckoutSession verifies a Stripe Checkout Session status (SaaS only).
- operationId: bytebase.v1.SubscriptionService.VerifyCheckoutSession
+ - bytebase.v1.SheetService
+ summary: GetSheet
+ description: |-
+ Retrieves a SQL sheet by name.
+ Permissions required: bb.sheets.get
+ operationId: bytebase.v1.SheetService.GetSheet
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6581,7 +6606,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.VerifyCheckoutSessionRequest'
+ $ref: '#/components/schemas/bytebase.v1.GetSheetRequest'
required: true
responses:
default:
@@ -6595,17 +6620,14 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.VerifyCheckoutSessionResponse'
- /bytebase.v1.UserService/BatchGetUsers:
+ $ref: '#/components/schemas/bytebase.v1.Sheet'
+ /bytebase.v1.SubscriptionService/CancelPurchase:
post:
tags:
- - bytebase.v1.UserService
- summary: BatchGetUsers
- description: |-
- Get the users in batch.
- Any authenticated user can batch get users.
- Permissions required: bb.users.get
- operationId: bytebase.v1.UserService.BatchGetUsers
+ - bytebase.v1.SubscriptionService
+ summary: CancelPurchase
+ description: CancelPurchase cancels an active subscription (SaaS only).
+ operationId: bytebase.v1.SubscriptionService.CancelPurchase
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6620,7 +6642,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.BatchGetUsersRequest'
+ $ref: '#/components/schemas/bytebase.v1.CancelPurchaseRequest'
required: true
responses:
default:
@@ -6634,17 +6656,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.BatchGetUsersResponse'
- /bytebase.v1.UserService/CreateUser:
+ $ref: '#/components/schemas/bytebase.v1.PurchaseResponse'
+ /bytebase.v1.SubscriptionService/CreatePurchase:
post:
tags:
- - bytebase.v1.UserService
- summary: CreateUser
+ - bytebase.v1.SubscriptionService
+ summary: CreatePurchase
description: |-
- Creates a user in the caller's workspace (admin action, self-hosted only).
- In SaaS mode, admins should add users via workspace IAM policy instead.
- Permissions required: bb.users.create
- operationId: bytebase.v1.UserService.CreateUser
+ CreatePurchase creates a new subscription purchase (SaaS only).
+ Returns a Stripe Checkout URL for the user to complete payment.
+ operationId: bytebase.v1.SubscriptionService.CreatePurchase
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6659,7 +6680,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.CreateUserRequest'
+ $ref: '#/components/schemas/bytebase.v1.CreatePurchaseRequest'
required: true
responses:
default:
@@ -6673,16 +6694,14 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.User'
- /bytebase.v1.UserService/DeleteUser:
+ $ref: '#/components/schemas/bytebase.v1.PurchaseResponse'
+ /bytebase.v1.SubscriptionService/ExportVCSProviderUsers:
post:
tags:
- - bytebase.v1.UserService
- summary: DeleteUser
- description: |-
- Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.
- Permissions required: bb.users.delete
- operationId: bytebase.v1.UserService.DeleteUser
+ - bytebase.v1.SubscriptionService
+ summary: ExportVCSProviderUsers
+ description: Exports active VCS users as CSV.
+ operationId: bytebase.v1.SubscriptionService.ExportVCSProviderUsers
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6697,7 +6716,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.DeleteUserRequest'
+ $ref: '#/components/schemas/bytebase.v1.ExportVCSProviderUsersRequest'
required: true
responses:
default:
@@ -6711,16 +6730,14 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/google.protobuf.Empty'
- /bytebase.v1.UserService/GetCurrentUser:
+ $ref: '#/components/schemas/google.api.HttpBody'
+ /bytebase.v1.SubscriptionService/GetPaymentInfo:
post:
tags:
- - bytebase.v1.UserService
- summary: GetCurrentUser
- description: |-
- Get the current authenticated user.
- Permissions required: None
- operationId: bytebase.v1.UserService.GetCurrentUser
+ - bytebase.v1.SubscriptionService
+ summary: GetPaymentInfo
+ description: GetPaymentInfo returns payment details for the current subscription (SaaS only).
+ operationId: bytebase.v1.SubscriptionService.GetPaymentInfo
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6735,7 +6752,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/google.protobuf.Empty'
+ $ref: '#/components/schemas/bytebase.v1.GetPaymentInfoRequest'
required: true
responses:
default:
@@ -6749,17 +6766,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.User'
- /bytebase.v1.UserService/GetUser:
+ $ref: '#/components/schemas/bytebase.v1.PaymentInfo'
+ /bytebase.v1.SubscriptionService/GetSubscription:
post:
tags:
- - bytebase.v1.UserService
- summary: GetUser
+ - bytebase.v1.SubscriptionService
+ summary: GetSubscription
description: |-
- Get the user.
- Any authenticated user can get the user.
- Permissions required: bb.users.get
- operationId: bytebase.v1.UserService.GetUser
+ GetSubscription returns the current subscription.
+ If there is no license, we will return a free plan subscription without expiration time.
+ If there is expired license, we will return a free plan subscription with the expiration time of the expired license.
+ operationId: bytebase.v1.SubscriptionService.GetSubscription
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6774,7 +6791,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.GetUserRequest'
+ $ref: '#/components/schemas/bytebase.v1.GetSubscriptionRequest'
required: true
responses:
default:
@@ -6788,17 +6805,14 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.User'
- /bytebase.v1.UserService/ListUsers:
+ $ref: '#/components/schemas/bytebase.v1.Subscription'
+ /bytebase.v1.SubscriptionService/ListPurchasePlans:
post:
tags:
- - bytebase.v1.UserService
- summary: ListUsers
- description: |-
- List all users.
- Any authenticated user can list users.
- Permissions required: bb.users.list
- operationId: bytebase.v1.UserService.ListUsers
+ - bytebase.v1.SubscriptionService
+ summary: ListPurchasePlans
+ description: ListPurchasePlans returns available plans for self-service purchase.
+ operationId: bytebase.v1.SubscriptionService.ListPurchasePlans
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6813,7 +6827,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListUsersRequest'
+ $ref: '#/components/schemas/bytebase.v1.ListPurchasePlansRequest'
required: true
responses:
default:
@@ -6827,16 +6841,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListUsersResponse'
- /bytebase.v1.UserService/UndeleteUser:
+ $ref: '#/components/schemas/bytebase.v1.ListPurchasePlansResponse'
+ /bytebase.v1.SubscriptionService/UpdatePurchase:
post:
tags:
- - bytebase.v1.UserService
- summary: UndeleteUser
+ - bytebase.v1.SubscriptionService
+ summary: UpdatePurchase
description: |-
- Restores a deleted user.
- Permissions required: bb.users.undelete
- operationId: bytebase.v1.UserService.UndeleteUser
+ UpdatePurchase updates an existing subscription (SaaS only).
+ May return a Stripe Checkout URL if payment method change is needed.
+ operationId: bytebase.v1.SubscriptionService.UpdatePurchase
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6851,7 +6865,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UndeleteUserRequest'
+ $ref: '#/components/schemas/bytebase.v1.UpdatePurchaseRequest'
required: true
responses:
default:
@@ -6865,16 +6879,14 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.User'
- /bytebase.v1.UserService/UpdateEmail:
+ $ref: '#/components/schemas/bytebase.v1.PurchaseResponse'
+ /bytebase.v1.SubscriptionService/UploadLicense:
post:
tags:
- - bytebase.v1.UserService
- summary: UpdateEmail
- description: |-
- Updates a user's email address.
- Permissions required: bb.users.updateEmail
- operationId: bytebase.v1.UserService.UpdateEmail
+ - bytebase.v1.SubscriptionService
+ summary: UploadLicense
+ description: Uploads an enterprise license (self-hosted only).
+ operationId: bytebase.v1.SubscriptionService.UploadLicense
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6889,7 +6901,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UpdateEmailRequest'
+ $ref: '#/components/schemas/bytebase.v1.UploadLicenseRequest'
required: true
responses:
default:
@@ -6903,17 +6915,14 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.User'
- /bytebase.v1.UserService/UpdateUser:
+ $ref: '#/components/schemas/bytebase.v1.Subscription'
+ /bytebase.v1.SubscriptionService/VerifyCheckoutSession:
post:
tags:
- - bytebase.v1.UserService
- summary: UpdateUser
- description: |-
- Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.
- Note: Email updates are not supported through this API. Use UpdateEmail instead.
- Permissions required: bb.users.update (or self)
- operationId: bytebase.v1.UserService.UpdateUser
+ - bytebase.v1.SubscriptionService
+ summary: VerifyCheckoutSession
+ description: VerifyCheckoutSession verifies a Stripe Checkout Session status (SaaS only).
+ operationId: bytebase.v1.SubscriptionService.VerifyCheckoutSession
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6928,7 +6937,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UpdateUserRequest'
+ $ref: '#/components/schemas/bytebase.v1.VerifyCheckoutSessionRequest'
required: true
responses:
default:
@@ -6942,17 +6951,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.User'
- /bytebase.v1.WorkloadIdentityService/CreateWorkloadIdentity:
+ $ref: '#/components/schemas/bytebase.v1.VerifyCheckoutSessionResponse'
+ /bytebase.v1.UserService/BatchGetUsers:
post:
tags:
- - bytebase.v1.WorkloadIdentityService
- summary: CreateWorkloadIdentity
+ - bytebase.v1.UserService
+ summary: BatchGetUsers
description: |-
- Creates a new workload identity.
- For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.create on workspace.
- For project-level: parent is projects/{project}, permission bb.workloadIdentities.create on project.
- operationId: bytebase.v1.WorkloadIdentityService.CreateWorkloadIdentity
+ Get the users in batch.
+ Any authenticated user can batch get users.
+ Permissions required: bb.users.get
+ operationId: bytebase.v1.UserService.BatchGetUsers
parameters:
- name: Connect-Protocol-Version
in: header
@@ -6967,7 +6976,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.CreateWorkloadIdentityRequest'
+ $ref: '#/components/schemas/bytebase.v1.BatchGetUsersRequest'
required: true
responses:
default:
@@ -6981,16 +6990,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
- /bytebase.v1.WorkloadIdentityService/DeleteWorkloadIdentity:
+ $ref: '#/components/schemas/bytebase.v1.BatchGetUsersResponse'
+ /bytebase.v1.UserService/CreateUser:
post:
tags:
- - bytebase.v1.WorkloadIdentityService
- summary: DeleteWorkloadIdentity
+ - bytebase.v1.UserService
+ summary: CreateUser
description: |-
- Deletes a workload identity.
- Permissions required: bb.workloadIdentities.delete
- operationId: bytebase.v1.WorkloadIdentityService.DeleteWorkloadIdentity
+ Creates a user in the caller's workspace (admin action, self-hosted only).
+ In SaaS mode, admins should add users via workspace IAM policy instead.
+ Permissions required: bb.users.create
+ operationId: bytebase.v1.UserService.CreateUser
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7005,7 +7015,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.DeleteWorkloadIdentityRequest'
+ $ref: '#/components/schemas/bytebase.v1.CreateUserRequest'
required: true
responses:
default:
@@ -7019,16 +7029,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/google.protobuf.Empty'
- /bytebase.v1.WorkloadIdentityService/GetWorkloadIdentity:
+ $ref: '#/components/schemas/bytebase.v1.User'
+ /bytebase.v1.UserService/DeleteUser:
post:
tags:
- - bytebase.v1.WorkloadIdentityService
- summary: GetWorkloadIdentity
+ - bytebase.v1.UserService
+ summary: DeleteUser
description: |-
- Gets a workload identity by name.
- Permissions required: bb.workloadIdentities.get
- operationId: bytebase.v1.WorkloadIdentityService.GetWorkloadIdentity
+ Deletes a user. Requires bb.users.delete permission with additional validation: the last remaining workspace admin cannot be deleted.
+ Permissions required: bb.users.delete
+ operationId: bytebase.v1.UserService.DeleteUser
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7043,7 +7053,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.GetWorkloadIdentityRequest'
+ $ref: '#/components/schemas/bytebase.v1.DeleteUserRequest'
required: true
responses:
default:
@@ -7057,17 +7067,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
- /bytebase.v1.WorkloadIdentityService/ListWorkloadIdentities:
+ $ref: '#/components/schemas/google.protobuf.Empty'
+ /bytebase.v1.UserService/GetCurrentUser:
post:
tags:
- - bytebase.v1.WorkloadIdentityService
- summary: ListWorkloadIdentities
+ - bytebase.v1.UserService
+ summary: GetCurrentUser
description: |-
- Lists workload identities.
- For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.list on workspace.
- For project-level: parent is projects/{project}, permission bb.workloadIdentities.list on project.
- operationId: bytebase.v1.WorkloadIdentityService.ListWorkloadIdentities
+ Get the current authenticated user.
+ Permissions required: None
+ operationId: bytebase.v1.UserService.GetCurrentUser
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7082,7 +7091,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListWorkloadIdentitiesRequest'
+ $ref: '#/components/schemas/google.protobuf.Empty'
required: true
responses:
default:
@@ -7096,16 +7105,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListWorkloadIdentitiesResponse'
- /bytebase.v1.WorkloadIdentityService/UndeleteWorkloadIdentity:
+ $ref: '#/components/schemas/bytebase.v1.User'
+ /bytebase.v1.UserService/GetUser:
post:
tags:
- - bytebase.v1.WorkloadIdentityService
- summary: UndeleteWorkloadIdentity
+ - bytebase.v1.UserService
+ summary: GetUser
description: |-
- Restores a deleted workload identity.
- Permissions required: bb.workloadIdentities.undelete
- operationId: bytebase.v1.WorkloadIdentityService.UndeleteWorkloadIdentity
+ Get the user.
+ Any authenticated user can get the user.
+ Permissions required: bb.users.get
+ operationId: bytebase.v1.UserService.GetUser
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7120,7 +7130,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UndeleteWorkloadIdentityRequest'
+ $ref: '#/components/schemas/bytebase.v1.GetUserRequest'
required: true
responses:
default:
@@ -7134,16 +7144,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
- /bytebase.v1.WorkloadIdentityService/UpdateWorkloadIdentity:
+ $ref: '#/components/schemas/bytebase.v1.User'
+ /bytebase.v1.UserService/ListUsers:
post:
tags:
- - bytebase.v1.WorkloadIdentityService
- summary: UpdateWorkloadIdentity
+ - bytebase.v1.UserService
+ summary: ListUsers
description: |-
- Updates a workload identity.
- Permissions required: bb.workloadIdentities.update
- operationId: bytebase.v1.WorkloadIdentityService.UpdateWorkloadIdentity
+ List all users.
+ Any authenticated user can list users.
+ Permissions required: bb.users.list
+ operationId: bytebase.v1.UserService.ListUsers
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7158,7 +7169,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UpdateWorkloadIdentityRequest'
+ $ref: '#/components/schemas/bytebase.v1.ListUsersRequest'
required: true
responses:
default:
@@ -7172,17 +7183,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
- /bytebase.v1.WorksheetService/BatchUpdateWorksheetOrganizer:
+ $ref: '#/components/schemas/bytebase.v1.ListUsersResponse'
+ /bytebase.v1.UserService/UndeleteUser:
post:
tags:
- - bytebase.v1.WorksheetService
- summary: BatchUpdateWorksheetOrganizer
+ - bytebase.v1.UserService
+ summary: UndeleteUser
description: |-
- Batch update the organizers of worksheets.
- The access is the same as UpdateWorksheet method.
- Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- operationId: bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer
+ Restores a deleted user.
+ Permissions required: bb.users.undelete
+ operationId: bytebase.v1.UserService.UndeleteUser
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7197,7 +7207,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.BatchUpdateWorksheetOrganizerRequest'
+ $ref: '#/components/schemas/bytebase.v1.UndeleteUserRequest'
required: true
responses:
default:
@@ -7211,16 +7221,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.BatchUpdateWorksheetOrganizerResponse'
- /bytebase.v1.WorksheetService/CreateWorksheet:
+ $ref: '#/components/schemas/bytebase.v1.User'
+ /bytebase.v1.UserService/UpdateEmail:
post:
tags:
- - bytebase.v1.WorksheetService
- summary: CreateWorksheet
+ - bytebase.v1.UserService
+ summary: UpdateEmail
description: |-
- Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
- Permissions required: None (authenticated users only)
- operationId: bytebase.v1.WorksheetService.CreateWorksheet
+ Updates a user's email address.
+ Permissions required: bb.users.updateEmail
+ operationId: bytebase.v1.UserService.UpdateEmail
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7235,7 +7245,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.CreateWorksheetRequest'
+ $ref: '#/components/schemas/bytebase.v1.UpdateEmailRequest'
required: true
responses:
default:
@@ -7249,17 +7259,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- /bytebase.v1.WorksheetService/DeleteWorksheet:
+ $ref: '#/components/schemas/bytebase.v1.User'
+ /bytebase.v1.UserService/UpdateUser:
post:
tags:
- - bytebase.v1.WorksheetService
- summary: DeleteWorksheet
+ - bytebase.v1.UserService
+ summary: UpdateUser
description: |-
- Delete a worksheet.
- The access is the same as UpdateWorksheet method.
- Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- operationId: bytebase.v1.WorksheetService.DeleteWorksheet
+ Updates a user. Users can update their own profile, or users with bb.users.update permission can update any user.
+ Note: Email updates are not supported through this API. Use UpdateEmail instead.
+ Permissions required: bb.users.update (or self)
+ operationId: bytebase.v1.UserService.UpdateUser
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7274,7 +7284,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.DeleteWorksheetRequest'
+ $ref: '#/components/schemas/bytebase.v1.UpdateUserRequest'
required: true
responses:
default:
@@ -7288,20 +7298,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/google.protobuf.Empty'
- /bytebase.v1.WorksheetService/GetWorksheet:
+ $ref: '#/components/schemas/bytebase.v1.User'
+ /bytebase.v1.WorkloadIdentityService/CreateWorkloadIdentity:
post:
tags:
- - bytebase.v1.WorksheetService
- summary: GetWorksheet
+ - bytebase.v1.WorkloadIdentityService
+ summary: CreateWorkloadIdentity
description: |-
- Get a worksheet by name.
- The users can access this method if,
- - they are the creator of the worksheet;
- - they have bb.worksheets.get permission on the workspace;
- - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- operationId: bytebase.v1.WorksheetService.GetWorksheet
+ Creates a new workload identity.
+ For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.create on workspace.
+ For project-level: parent is projects/{project}, permission bb.workloadIdentities.create on project.
+ operationId: bytebase.v1.WorkloadIdentityService.CreateWorkloadIdentity
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7316,7 +7323,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.GetWorksheetRequest'
+ $ref: '#/components/schemas/bytebase.v1.CreateWorkloadIdentityRequest'
required: true
responses:
default:
@@ -7330,16 +7337,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- /bytebase.v1.WorksheetService/ListWorksheetFolders:
+ $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
+ /bytebase.v1.WorkloadIdentityService/DeleteWorkloadIdentity:
post:
tags:
- - bytebase.v1.WorksheetService
- summary: ListWorksheetFolders
+ - bytebase.v1.WorkloadIdentityService
+ summary: DeleteWorkloadIdentity
description: |-
- List the caller's worksheet folders.
- Only folders stored in the caller's worksheet organizer are returned.
- operationId: bytebase.v1.WorksheetService.ListWorksheetFolders
+ Deletes a workload identity.
+ Permissions required: bb.workloadIdentities.delete
+ operationId: bytebase.v1.WorkloadIdentityService.DeleteWorkloadIdentity
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7354,7 +7361,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListWorksheetFoldersRequest'
+ $ref: '#/components/schemas/bytebase.v1.DeleteWorkloadIdentityRequest'
required: true
responses:
default:
@@ -7368,17 +7375,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListWorksheetFoldersResponse'
- /bytebase.v1.WorksheetService/ListWorksheets:
+ $ref: '#/components/schemas/google.protobuf.Empty'
+ /bytebase.v1.WorkloadIdentityService/GetWorkloadIdentity:
post:
tags:
- - bytebase.v1.WorksheetService
- summary: ListWorksheets
+ - bytebase.v1.WorkloadIdentityService
+ summary: GetWorkloadIdentity
description: |-
- List worksheets.
- This is used for listing worksheets in a project, or across all projects by using `projects/-`.
- Permissions required: bb.worksheets.list
- operationId: bytebase.v1.WorksheetService.ListWorksheets
+ Gets a workload identity by name.
+ Permissions required: bb.workloadIdentities.get
+ operationId: bytebase.v1.WorkloadIdentityService.GetWorkloadIdentity
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7393,7 +7399,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListWorksheetsRequest'
+ $ref: '#/components/schemas/bytebase.v1.GetWorkloadIdentityRequest'
required: true
responses:
default:
@@ -7407,18 +7413,17 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListWorksheetsResponse'
- /bytebase.v1.WorksheetService/SearchWorksheets:
+ $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
+ /bytebase.v1.WorkloadIdentityService/ListWorkloadIdentities:
post:
tags:
- - bytebase.v1.WorksheetService
- summary: SearchWorksheets
+ - bytebase.v1.WorkloadIdentityService
+ summary: ListWorkloadIdentities
description: |-
- Search for worksheets.
- This is used for finding my worksheets or worksheets shared by other people.
- The sheet accessibility is the same as GetWorksheet().
- Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- operationId: bytebase.v1.WorksheetService.SearchWorksheets
+ Lists workload identities.
+ For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.list on workspace.
+ For project-level: parent is projects/{project}, permission bb.workloadIdentities.list on project.
+ operationId: bytebase.v1.WorkloadIdentityService.ListWorkloadIdentities
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7433,7 +7438,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.SearchWorksheetsRequest'
+ $ref: '#/components/schemas/bytebase.v1.ListWorkloadIdentitiesRequest'
required: true
responses:
default:
@@ -7447,20 +7452,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.SearchWorksheetsResponse'
- /bytebase.v1.WorksheetService/UpdateWorksheet:
+ $ref: '#/components/schemas/bytebase.v1.ListWorkloadIdentitiesResponse'
+ /bytebase.v1.WorkloadIdentityService/UndeleteWorkloadIdentity:
post:
tags:
- - bytebase.v1.WorksheetService
- summary: UpdateWorksheet
+ - bytebase.v1.WorkloadIdentityService
+ summary: UndeleteWorkloadIdentity
description: |-
- Update a worksheet.
- The users can access this method if,
- - they are the creator of the worksheet;
- - they have bb.worksheets.manage permission on the workspace;
- - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- operationId: bytebase.v1.WorksheetService.UpdateWorksheet
+ Restores a deleted workload identity.
+ Permissions required: bb.workloadIdentities.undelete
+ operationId: bytebase.v1.WorkloadIdentityService.UndeleteWorkloadIdentity
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7475,7 +7476,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UpdateWorksheetRequest'
+ $ref: '#/components/schemas/bytebase.v1.UndeleteWorkloadIdentityRequest'
required: true
responses:
default:
@@ -7489,17 +7490,16 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- /bytebase.v1.WorksheetService/UpdateWorksheetOrganizer:
+ $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
+ /bytebase.v1.WorkloadIdentityService/UpdateWorkloadIdentity:
post:
tags:
- - bytebase.v1.WorksheetService
- summary: UpdateWorksheetOrganizer
+ - bytebase.v1.WorkloadIdentityService
+ summary: UpdateWorkloadIdentity
description: |-
- Update the organizer of a worksheet.
- The access is the same as UpdateWorksheet method.
- Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- operationId: bytebase.v1.WorksheetService.UpdateWorksheetOrganizer
+ Updates a workload identity.
+ Permissions required: bb.workloadIdentities.update
+ operationId: bytebase.v1.WorkloadIdentityService.UpdateWorkloadIdentity
parameters:
- name: Connect-Protocol-Version
in: header
@@ -7514,7 +7514,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.UpdateWorksheetOrganizerRequest'
+ $ref: '#/components/schemas/bytebase.v1.UpdateWorkloadIdentityRequest'
required: true
responses:
default:
@@ -7528,7 +7528,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
+ $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
/bytebase.v1.WorkspaceService/DeleteWorkspace:
post:
tags:
@@ -9286,14 +9286,14 @@ components:
type: object
title: BatchUpdateIssuesStatusResponse
additionalProperties: false
- bytebase.v1.BatchUpdateWorksheetOrganizerRequest:
+ bytebase.v1.BatchUpdateSavedQueryOrganizerRequest:
type: object
properties:
parent:
type: string
title: parent
description: |-
- The parent resource whose worksheets' organizers are updated.
+ The parent resource whose saved queries' organizers are updated.
Format: projects/{project}
filter:
type: string
@@ -9303,39 +9303,39 @@ components:
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
- - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- - folder: the worksheet organizer folder path, support exact "==" operator.
+ - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ - folder: the saved query organizer folder path, support exact "==" operator.
organizer:
title: organizer
description: The organizer fields to update.
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
updateMask:
title: update_mask
description: |-
The list of fields to be updated.
- Fields are specified relative to the worksheet organizer.
+ Fields are specified relative to the saved query organizer.
Only support update the following fields for now:
- `starred`
- `folders`
$ref: '#/components/schemas/google.protobuf.FieldMask'
- title: BatchUpdateWorksheetOrganizerRequest
+ title: BatchUpdateSavedQueryOrganizerRequest
additionalProperties: false
- bytebase.v1.BatchUpdateWorksheetOrganizerResponse:
+ bytebase.v1.BatchUpdateSavedQueryOrganizerResponse:
type: object
properties:
- worksheetOrganizers:
+ savedQueryOrganizers:
type: array
items:
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
- title: worksheet_organizers
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
+ title: saved_query_organizers
updatedCount:
type: integer
title: updated_count
format: int32
- title: BatchUpdateWorksheetOrganizerResponse
+ title: BatchUpdateSavedQueryOrganizerResponse
additionalProperties: false
bytebase.v1.BillingInterval:
type: string
@@ -10162,6 +10162,21 @@ components:
If set to "", no stages are created.
title: CreateRolloutRequest
additionalProperties: false
+ bytebase.v1.CreateSavedQueryRequest:
+ type: object
+ properties:
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource where this saved query will be created.
+ Format: projects/{project}
+ savedQuery:
+ title: saved_query
+ description: The saved query to create.
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ title: CreateSavedQueryRequest
+ additionalProperties: false
bytebase.v1.CreateServiceAccountRequest:
type: object
properties:
@@ -10232,21 +10247,6 @@ components:
title: CreateWorkloadIdentityRequest
additionalProperties: false
description: Request message for creating a workload identity.
- bytebase.v1.CreateWorksheetRequest:
- type: object
- properties:
- parent:
- type: string
- title: parent
- description: |-
- The parent resource where this worksheet will be created.
- Format: projects/{project}
- worksheet:
- title: worksheet
- description: The worksheet to create.
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- title: CreateWorksheetRequest
- additionalProperties: false
bytebase.v1.DataClassificationSetting:
type: object
properties:
@@ -11187,6 +11187,17 @@ components:
Format: roles/{role}
title: DeleteRoleRequest
additionalProperties: false
+ bytebase.v1.DeleteSavedQueryRequest:
+ type: object
+ properties:
+ name:
+ type: string
+ title: name
+ description: |-
+ The name of the saved query to delete.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ title: DeleteSavedQueryRequest
+ additionalProperties: false
bytebase.v1.DeleteServiceAccountRequest:
type: object
properties:
@@ -11222,17 +11233,6 @@ components:
title: DeleteWorkloadIdentityRequest
additionalProperties: false
description: Request message for deleting a workload identity.
- bytebase.v1.DeleteWorksheetRequest:
- type: object
- properties:
- name:
- type: string
- title: name
- description: |-
- The name of the worksheet to delete.
- Format: projects/{project}/worksheets/{worksheet}
- title: DeleteWorksheetRequest
- additionalProperties: false
bytebase.v1.DeleteWorkspaceRequest:
type: object
properties:
@@ -12294,6 +12294,17 @@ components:
Format: projects/{project}/plans/{plan}/rollout
title: GetRolloutRequest
additionalProperties: false
+ bytebase.v1.GetSavedQueryRequest:
+ type: object
+ properties:
+ name:
+ type: string
+ title: name
+ description: |-
+ The name of the saved query to retrieve.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ title: GetSavedQueryRequest
+ additionalProperties: false
bytebase.v1.GetSchemaStringRequest:
type: object
properties:
@@ -12443,17 +12454,6 @@ components:
title: GetWorkloadIdentityRequest
additionalProperties: false
description: Request message for getting a workload identity.
- bytebase.v1.GetWorksheetRequest:
- type: object
- properties:
- name:
- type: string
- title: name
- description: |-
- The name of the worksheet to retrieve.
- Format: projects/{project}/worksheets/{worksheet}
- title: GetWorksheetRequest
- additionalProperties: false
bytebase.v1.GetWorkspaceRequest:
type: object
properties:
@@ -14456,6 +14456,89 @@ components:
If this field is omitted, there are no subsequent pages.
title: ListRolloutsResponse
additionalProperties: false
+ bytebase.v1.ListSavedQueriesRequest:
+ type: object
+ properties:
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource of the saved queries.
+ Format: projects/{project}
+ Use "projects/-" to list saved queries across all projects.
+ filter:
+ type: string
+ title: filter
+ description: |-
+ To filter the list result.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+ Supported filter:
+ - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+
+ For example:
+ creator == "users/{email}"
+ creator != "users/{email}"
+ pageSize:
+ type: integer
+ title: page_size
+ format: int32
+ description: |-
+ The maximum number of saved queries to return. The service may return fewer than
+ this value.
+ If unspecified, at most 10 saved queries will be returned.
+ The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken:
+ type: string
+ title: page_token
+ description: |-
+ A page token, received from a previous `ListSavedQueries` call.
+ Provide this to retrieve the subsequent page.
+
+ When paginating, all other parameters provided to `ListSavedQueries` must match
+ the call that provided the page token.
+ title: ListSavedQueriesRequest
+ additionalProperties: false
+ bytebase.v1.ListSavedQueriesResponse:
+ type: object
+ properties:
+ savedQueries:
+ type: array
+ items:
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ title: saved_queries
+ description: The saved queries from the specified parent.
+ nextPageToken:
+ type: string
+ title: next_page_token
+ description: |-
+ A token to retrieve next page of saved queries.
+ Pass this value in the page_token field in the subsequent call to
+ `ListSavedQueries` method to retrieve the next page of saved queries.
+ title: ListSavedQueriesResponse
+ additionalProperties: false
+ bytebase.v1.ListSavedQueryFoldersRequest:
+ type: object
+ properties:
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource of the saved query folders.
+ Format: projects/{project}
+ title: ListSavedQueryFoldersRequest
+ additionalProperties: false
+ bytebase.v1.ListSavedQueryFoldersResponse:
+ type: object
+ properties:
+ folders:
+ type: array
+ items:
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryFolder'
+ title: folders
+ description: The caller's saved query folders.
+ title: ListSavedQueryFoldersResponse
+ additionalProperties: false
bytebase.v1.ListServiceAccountsRequest:
type: object
properties:
@@ -14701,89 +14784,6 @@ components:
title: ListWorkloadIdentitiesResponse
additionalProperties: false
description: Response message for listing workload identities.
- bytebase.v1.ListWorksheetFoldersRequest:
- type: object
- properties:
- parent:
- type: string
- title: parent
- description: |-
- The parent resource of the worksheet folders.
- Format: projects/{project}
- title: ListWorksheetFoldersRequest
- additionalProperties: false
- bytebase.v1.ListWorksheetFoldersResponse:
- type: object
- properties:
- folders:
- type: array
- items:
- $ref: '#/components/schemas/bytebase.v1.WorksheetFolder'
- title: folders
- description: The caller's worksheet folders.
- title: ListWorksheetFoldersResponse
- additionalProperties: false
- bytebase.v1.ListWorksheetsRequest:
- type: object
- properties:
- parent:
- type: string
- title: parent
- description: |-
- The parent resource of the worksheets.
- Format: projects/{project}
- Use "projects/-" to list worksheets across all projects.
- filter:
- type: string
- title: filter
- description: |-
- To filter the list result.
- The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
- Supported filter:
- - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
-
- For example:
- creator == "users/{email}"
- creator != "users/{email}"
- pageSize:
- type: integer
- title: page_size
- format: int32
- description: |-
- The maximum number of worksheets to return. The service may return fewer than
- this value.
- If unspecified, at most 10 worksheets will be returned.
- The maximum value is 1000; values above 1000 will be coerced to 1000.
- pageToken:
- type: string
- title: page_token
- description: |-
- A page token, received from a previous `ListWorksheets` call.
- Provide this to retrieve the subsequent page.
-
- When paginating, all other parameters provided to `ListWorksheets` must match
- the call that provided the page token.
- title: ListWorksheetsRequest
- additionalProperties: false
- bytebase.v1.ListWorksheetsResponse:
- type: object
- properties:
- worksheets:
- type: array
- items:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- title: worksheets
- description: The worksheets from the specified parent.
- nextPageToken:
- type: string
- title: next_page_token
- description: |-
- A token to retrieve next page of worksheets.
- Pass this value in the page_token field in the subsequent call to
- `ListWorksheets` method to retrieve the next page of worksheets.
- title: ListWorksheetsResponse
- additionalProperties: false
bytebase.v1.ListWorkspacesRequest:
type: object
title: ListWorkspacesRequest
@@ -17676,6 +17676,127 @@ components:
- BUILTIN_WALK_THROUGH_CHECK
- STATEMENT_DISALLOW_TRUNCATE
- BUILTIN_STATEMENT_MAXIMUM_SQL_SIZE
+ bytebase.v1.SavedQuery:
+ type: object
+ properties:
+ name:
+ type: string
+ title: name
+ description: |-
+ The name of the saved query resource, generated by the server.
+ Canonical parent is project.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ project:
+ type: string
+ title: project
+ description: |-
+ The project resource name.
+ Format: projects/{project}
+ database:
+ type: string
+ title: database
+ description: |-
+ The database resource name.
+ Format: instances/{instance}/databases/{database}
+ If the database parent doesn't exist, the database field is empty.
+ title:
+ type: string
+ title: title
+ maxLength: 200
+ description: The title of the saved query.
+ creator:
+ type: string
+ title: creator
+ description: |-
+ The creator of the SavedQuery.
+ Format: users/{email}
+ createTime:
+ title: create_time
+ description: The create time of the saved query.
+ $ref: '#/components/schemas/google.protobuf.Timestamp'
+ updateTime:
+ title: update_time
+ description: The last update time of the saved query.
+ $ref: '#/components/schemas/google.protobuf.Timestamp'
+ content:
+ type: string
+ title: content
+ format: byte
+ description: |-
+ The content of the saved query.
+ By default, it will be cut off in SearchSavedQueries() method. If it doesn't match the `content_size`, you can
+ use GetSavedQuery() request to retrieve the full content.
+ contentSize:
+ type:
+ - integer
+ - string
+ title: content_size
+ format: int64
+ description: content_size is the full size of the content, may not match the size of the `content` field.
+ visibility:
+ title: visibility
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery.Visibility'
+ starred:
+ type: boolean
+ title: starred
+ description: starred indicates whether the saved query is starred by the current authenticated user.
+ folders:
+ type: array
+ items:
+ type: string
+ title: folders
+ title: SavedQuery
+ additionalProperties: false
+ bytebase.v1.SavedQuery.Visibility:
+ type: string
+ title: Visibility
+ enum:
+ - VISIBILITY_UNSPECIFIED
+ - PROJECT_READ
+ - PROJECT_WRITE
+ - PRIVATE
+ bytebase.v1.SavedQueryFolder:
+ type: object
+ properties:
+ folders:
+ type: array
+ items:
+ type: string
+ title: folders
+ description: The folder path segments.
+ category:
+ title: category
+ description: The folder category.
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryFolder.Category'
+ title: SavedQueryFolder
+ additionalProperties: false
+ bytebase.v1.SavedQueryFolder.Category:
+ type: string
+ title: Category
+ enum:
+ - CATEGORY_UNSPECIFIED
+ - MINE
+ - SHARED
+ bytebase.v1.SavedQueryOrganizer:
+ type: object
+ properties:
+ savedQuery:
+ type: string
+ title: saved_query
+ description: |-
+ The name of the saved query.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ starred:
+ type: boolean
+ title: starred
+ description: starred means if the saved query is starred.
+ folders:
+ type: array
+ items:
+ type: string
+ title: folders
+ title: SavedQueryOrganizer
+ additionalProperties: false
bytebase.v1.SchemaCatalog:
type: object
properties:
@@ -18139,14 +18260,14 @@ components:
`ListQueryHistory` method to retrieve the next page of history.
title: SearchQueryHistoriesResponse
additionalProperties: false
- bytebase.v1.SearchWorksheetsRequest:
+ bytebase.v1.SearchSavedQueriesRequest:
type: object
properties:
parent:
type: string
title: parent
description: |-
- The parent resource of the worksheets.
+ The parent resource of the saved queries.
Format: projects/{project}
filter:
type: string
@@ -18156,16 +18277,16 @@ components:
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
- - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- - title: the worksheet title, support "contains" operator.
- - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- - folder: the worksheet organizer folder path, support "==" operator.
+ - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ - title: the saved query title, support "contains" operator.
+ - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ - folder: the saved query organizer folder path, support "==" operator.
For example:
creator == "users/{email}"
- title.contains("worksheet title")
+ title.contains("saved query title")
creator != "users/{email}"
starred == true
starred == false
@@ -18177,35 +18298,35 @@ components:
title: page_size
format: int32
description: |-
- The maximum number of worksheets to return. The service may return fewer than
+ The maximum number of saved queries to return. The service may return fewer than
this value.
- If unspecified, at most 10 worksheets will be returned.
+ If unspecified, at most 10 saved queries will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken:
type: string
title: page_token
description: |-
- A page token, received from a previous `SearchWorksheets` call.
+ A page token, received from a previous `SearchSavedQueries` call.
Provide this to retrieve the subsequent page.
- title: SearchWorksheetsRequest
+ title: SearchSavedQueriesRequest
additionalProperties: false
- bytebase.v1.SearchWorksheetsResponse:
+ bytebase.v1.SearchSavedQueriesResponse:
type: object
properties:
- worksheets:
+ savedQueries:
type: array
items:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- title: worksheets
- description: The worksheets that matched the search criteria.
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ title: saved_queries
+ description: The saved queries that matched the search criteria.
nextPageToken:
type: string
title: next_page_token
description: |-
- A token to retrieve next page of worksheets.
+ A token to retrieve next page of saved queries.
Pass this value in the page_token field in the subsequent call to
- `SearchWorksheets` method to retrieve the next page of worksheets.
- title: SearchWorksheetsResponse
+ `SearchSavedQueries` method to retrieve the next page of saved queries.
+ title: SearchSavedQueriesResponse
additionalProperties: false
bytebase.v1.SemanticTypeSetting:
type: object
@@ -20518,6 +20639,58 @@ components:
In this situation, `update_mask` is ignored.
title: UpdateRoleRequest
additionalProperties: false
+ bytebase.v1.UpdateSavedQueryOrganizerRequest:
+ type: object
+ properties:
+ organizer:
+ title: organizer
+ description: |-
+ The organizer to update.
+
+ The organizer's `saved_query` field is used to identify the saved query.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
+ updateMask:
+ title: update_mask
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the saved query organizer.
+ Only support update the following fields for now:
+ - `starred`
+ $ref: '#/components/schemas/google.protobuf.FieldMask'
+ allowMissing:
+ type: boolean
+ title: allow_missing
+ description: |-
+ If set to true, and the saved query organizer is not found, a new saved query organizer will be created.
+ In this situation, `update_mask` is ignored.
+ title: UpdateSavedQueryOrganizerRequest
+ additionalProperties: false
+ bytebase.v1.UpdateSavedQueryRequest:
+ type: object
+ properties:
+ savedQuery:
+ title: saved_query
+ description: |-
+ The saved query to update.
+
+ The saved query's `name` field is used to identify the saved query to update.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ updateMask:
+ title: update_mask
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the saved query.
+ (e.g., `title`, `statement`; *not* `saved_query.title` or `saved_query.statement`)
+ Only support update the following fields for now:
+ - `title`
+ - `statement`
+ - `starred`
+ - `visibility`
+ $ref: '#/components/schemas/google.protobuf.FieldMask'
+ title: UpdateSavedQueryRequest
+ additionalProperties: false
bytebase.v1.UpdateServiceAccountRequest:
type: object
properties:
@@ -20638,58 +20811,6 @@ components:
title: UpdateWorkloadIdentityRequest
additionalProperties: false
description: Request message for updating a workload identity.
- bytebase.v1.UpdateWorksheetOrganizerRequest:
- type: object
- properties:
- organizer:
- title: organizer
- description: |-
- The organizer to update.
-
- The organizer's `worksheet` field is used to identify the worksheet.
- Format: projects/{project}/worksheets/{worksheet}
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
- updateMask:
- title: update_mask
- description: |-
- The list of fields to be updated.
- Fields are specified relative to the worksheet organizer.
- Only support update the following fields for now:
- - `starred`
- $ref: '#/components/schemas/google.protobuf.FieldMask'
- allowMissing:
- type: boolean
- title: allow_missing
- description: |-
- If set to true, and the worksheet organizer is not found, a new worksheet organizer will be created.
- In this situation, `update_mask` is ignored.
- title: UpdateWorksheetOrganizerRequest
- additionalProperties: false
- bytebase.v1.UpdateWorksheetRequest:
- type: object
- properties:
- worksheet:
- title: worksheet
- description: |-
- The worksheet to update.
-
- The worksheet's `name` field is used to identify the worksheet to update.
- Format: projects/{project}/worksheets/{worksheet}
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- updateMask:
- title: update_mask
- description: |-
- The list of fields to be updated.
- Fields are specified relative to the worksheet.
- (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)
- Only support update the following fields for now:
- - `title`
- - `statement`
- - `starred`
- - `visibility`
- $ref: '#/components/schemas/google.protobuf.FieldMask'
- title: UpdateWorksheetRequest
- additionalProperties: false
bytebase.v1.UpdateWorkspaceRequest:
type: object
properties:
@@ -21012,127 +21133,6 @@ components:
- GITHUB
- GITLAB
description: ProviderType identifies the CI/CD platform.
- bytebase.v1.Worksheet:
- type: object
- properties:
- name:
- type: string
- title: name
- description: |-
- The name of the worksheet resource, generated by the server.
- Canonical parent is project.
- Format: projects/{project}/worksheets/{worksheet}
- project:
- type: string
- title: project
- description: |-
- The project resource name.
- Format: projects/{project}
- database:
- type: string
- title: database
- description: |-
- The database resource name.
- Format: instances/{instance}/databases/{database}
- If the database parent doesn't exist, the database field is empty.
- title:
- type: string
- title: title
- maxLength: 200
- description: The title of the worksheet.
- creator:
- type: string
- title: creator
- description: |-
- The creator of the Worksheet.
- Format: users/{email}
- createTime:
- title: create_time
- description: The create time of the worksheet.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
- updateTime:
- title: update_time
- description: The last update time of the worksheet.
- $ref: '#/components/schemas/google.protobuf.Timestamp'
- content:
- type: string
- title: content
- format: byte
- description: |-
- The content of the worksheet.
- By default, it will be cut off in SearchWorksheet() method. If it doesn't match the `content_size`, you can
- use GetWorksheet() request to retrieve the full content.
- contentSize:
- type:
- - integer
- - string
- title: content_size
- format: int64
- description: content_size is the full size of the content, may not match the size of the `content` field.
- visibility:
- title: visibility
- $ref: '#/components/schemas/bytebase.v1.Worksheet.Visibility'
- starred:
- type: boolean
- title: starred
- description: starred indicates whether the worksheet is starred by the current authenticated user.
- folders:
- type: array
- items:
- type: string
- title: folders
- title: Worksheet
- additionalProperties: false
- bytebase.v1.Worksheet.Visibility:
- type: string
- title: Visibility
- enum:
- - VISIBILITY_UNSPECIFIED
- - PROJECT_READ
- - PROJECT_WRITE
- - PRIVATE
- bytebase.v1.WorksheetFolder:
- type: object
- properties:
- folders:
- type: array
- items:
- type: string
- title: folders
- description: The folder path segments.
- category:
- title: category
- description: The folder category.
- $ref: '#/components/schemas/bytebase.v1.WorksheetFolder.Category'
- title: WorksheetFolder
- additionalProperties: false
- bytebase.v1.WorksheetFolder.Category:
- type: string
- title: Category
- enum:
- - CATEGORY_UNSPECIFIED
- - MINE
- - SHARED
- bytebase.v1.WorksheetOrganizer:
- type: object
- properties:
- worksheet:
- type: string
- title: worksheet
- description: |-
- The name of the worksheet.
- Format: projects/{project}/worksheets/{worksheet}
- starred:
- type: boolean
- title: starred
- description: starred means if the worksheet is starred.
- folders:
- type: array
- items:
- type: string
- title: folders
- title: WorksheetOrganizer
- additionalProperties: false
bytebase.v1.Workspace:
type: object
properties:
@@ -22790,6 +22790,11 @@ tags:
description: RevisionService manages schema revision history.
- name: bytebase.v1.RoleService
description: RoleService manages workspace roles and permissions.
+ - name: bytebase.v1.SavedQueryService
+ description: |-
+ SavedQueryService manages saved queries for SQL Editor query development.
+ Permission IDs still use the legacy `bb.worksheets.*` names; they are
+ renamed together with the access-model redesign and its role migration.
- name: bytebase.v1.ServiceAccountService
description: ServiceAccountService manages service accounts for API integrations.
- name: bytebase.v1.SheetService
@@ -22798,7 +22803,5 @@ tags:
description: SubscriptionService manages enterprise subscriptions and licensing.
- name: bytebase.v1.WorkloadIdentityService
description: WorkloadIdentityService manages workload identities for external CI/CD integrations.
- - name: bytebase.v1.WorksheetService
- description: WorksheetService manages SQL worksheets for query development.
- name: bytebase.v1.WorkspaceService
description: WorkspaceService manages workspace-level operations and profile.
diff --git a/backend/api/v1/interactive_project_database_test.go b/backend/api/v1/interactive_project_database_test.go
index 5a38221df7..16b0acaa3e 100644
--- a/backend/api/v1/interactive_project_database_test.go
+++ b/backend/api/v1/interactive_project_database_test.go
@@ -39,39 +39,39 @@ func TestBOT36SQLPrepareRelatedMessageRequiresCanonicalActiveOwner(t *testing.T)
require.Equal(t, connect.CodeNotFound, connect.CodeOf(err))
}
-func TestBOT36WorksheetDatabasesUseCanonicalOwningProjectNames(t *testing.T) {
+func TestBOT36SavedQueryDatabasesUseCanonicalOwningProjectNames(t *testing.T) {
ctx, stores, projectID, instanceID, databaseName := setupBOT36ProjectDatabase(t)
- service := NewWorksheetService(stores, nil)
+ service := NewSavedQueryService(stores, nil)
- _, err := service.getWorksheetDatabase(ctx, projectID, common.FormatDatabase(instanceID, databaseName))
+ _, err := service.getSavedQueryDatabase(ctx, projectID, common.FormatDatabase(instanceID, databaseName))
require.Equal(t, connect.CodeInvalidArgument, connect.CodeOf(err))
- _, err = service.getWorksheetDatabase(ctx, projectID, common.FormatProjectDatabase("other-project", instanceID, databaseName))
+ _, err = service.getSavedQueryDatabase(ctx, projectID, common.FormatProjectDatabase("other-project", instanceID, databaseName))
require.Equal(t, connect.CodeNotFound, connect.CodeOf(err))
- database, err := service.getWorksheetDatabase(ctx, projectID, common.FormatProjectDatabase(projectID, instanceID, databaseName))
+ database, err := service.getSavedQueryDatabase(ctx, projectID, common.FormatProjectDatabase(projectID, instanceID, databaseName))
require.NoError(t, err)
require.Equal(t, databaseName, database.DatabaseName)
- worksheet, err := service.convertWorksheetToAPI(ctx, &store.WorkSheetMessage{
+ savedQuery, err := service.convertToAPISavedQuery(ctx, &store.WorkSheetMessage{
ProjectID: projectID,
- ResourceID: "worksheet-a",
+ ResourceID: "saved-query-a",
InstanceID: &instanceID,
DatabaseName: &databaseName,
})
require.NoError(t, err)
- require.Equal(t, common.FormatProjectDatabase(projectID, instanceID, databaseName), worksheet.Database)
+ require.Equal(t, common.FormatProjectDatabase(projectID, instanceID, databaseName), savedQuery.Database)
- workspaceDatabase, err := service.getWorksheetDatabase(ctx, projectID, common.FormatDatabase("workspace-instance", "shared"))
+ workspaceDatabase, err := service.getSavedQueryDatabase(ctx, projectID, common.FormatDatabase("workspace-instance", "shared"))
require.NoError(t, err)
- workspaceWorksheet, err := service.convertWorksheetToAPI(ctx, &store.WorkSheetMessage{
+ workspaceSavedQuery, err := service.convertToAPISavedQuery(ctx, &store.WorkSheetMessage{
ProjectID: projectID,
- ResourceID: "worksheet-b",
+ ResourceID: "saved-query-b",
InstanceID: &workspaceDatabase.InstanceID,
DatabaseName: &workspaceDatabase.DatabaseName,
})
require.NoError(t, err)
- require.Equal(t, common.FormatDatabase("workspace-instance", "shared"), workspaceWorksheet.Database)
+ require.Equal(t, common.FormatDatabase("workspace-instance", "shared"), workspaceSavedQuery.Database)
}
func TestBOT36AccessGrantTargetsRequireCanonicalOwningProject(t *testing.T) {
diff --git a/backend/api/v1/worksheet_service.go b/backend/api/v1/saved_query_service.go
similarity index 57%
rename from backend/api/v1/worksheet_service.go
rename to backend/api/v1/saved_query_service.go
index 7574e48332..ce1fdd33d8 100644
--- a/backend/api/v1/worksheet_service.go
+++ b/backend/api/v1/saved_query_service.go
@@ -20,29 +20,31 @@ import (
"github.com/bytebase/bytebase/backend/store"
)
-// WorksheetService implements the worksheet service.
-type WorksheetService struct {
- v1connect.UnimplementedWorksheetServiceHandler
+// SavedQueryService implements the saved query service.
+// The store layer still uses the legacy worksheet naming (table `worksheet`);
+// this service converts between the two at the API boundary.
+type SavedQueryService struct {
+ v1connect.UnimplementedSavedQueryServiceHandler
store *store.Store
iamManager *iam.Manager
}
-// NewWorksheetService creates a new WorksheetService.
-func NewWorksheetService(store *store.Store, iamManager *iam.Manager) *WorksheetService {
- return &WorksheetService{
+// NewSavedQueryService creates a new SavedQueryService.
+func NewSavedQueryService(store *store.Store, iamManager *iam.Manager) *SavedQueryService {
+ return &SavedQueryService{
store: store,
iamManager: iamManager,
}
}
-// CreateWorksheet creates a new worksheet.
-func (s *WorksheetService) CreateWorksheet(
+// CreateSavedQuery creates a new saved query.
+func (s *SavedQueryService) CreateSavedQuery(
ctx context.Context,
- req *connect.Request[v1pb.CreateWorksheetRequest],
-) (*connect.Response[v1pb.Worksheet], error) {
+ req *connect.Request[v1pb.CreateSavedQueryRequest],
+) (*connect.Response[v1pb.SavedQuery], error) {
request := req.Msg
- if request.Worksheet == nil {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("worksheet must be set"))
+ if request.SavedQuery == nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("saved query must be set"))
}
user, ok := GetUserFromContext(ctx)
if !ok {
@@ -68,62 +70,62 @@ func (s *WorksheetService) CreateWorksheet(
}
var database *store.DatabaseMessage
- if request.Worksheet.Database != "" {
- database, err = s.getWorksheetDatabase(ctx, projectResourceID, request.Worksheet.Database)
+ if request.SavedQuery.Database != "" {
+ database, err = s.getSavedQueryDatabase(ctx, projectResourceID, request.SavedQuery.Database)
if err != nil {
return nil, err
}
}
- storeWorksheetCreate, err := convertToStoreWorksheetMessage(project, database, user.Email, request.Worksheet)
+ storeSavedQueryCreate, err := convertToStoreWorkSheetMessage(project, database, user.Email, request.SavedQuery)
if err != nil {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("failed to convert worksheet: %v", err))
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("failed to convert saved query: %v", err))
}
- worksheet, err := s.store.CreateWorkSheet(ctx, storeWorksheetCreate)
+ savedQuery, err := s.store.CreateWorkSheet(ctx, storeSavedQueryCreate)
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to create worksheet: %v", err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to create saved query: %v", err))
}
- v1pbWorksheet, err := s.convertWorksheetToAPI(ctx, worksheet)
+ v1pbSavedQuery, err := s.convertToAPISavedQuery(ctx, savedQuery)
if err != nil {
return nil, err
}
- return connect.NewResponse(v1pbWorksheet), nil
+ return connect.NewResponse(v1pbSavedQuery), nil
}
-// GetWorksheet returns the requested worksheet, cutoff the content if the content is too long and the `raw` flag in request is false.
-func (s *WorksheetService) GetWorksheet(
+// GetSavedQuery returns the requested saved query, cutoff the content if the content is too long and the `raw` flag in request is false.
+func (s *SavedQueryService) GetSavedQuery(
ctx context.Context,
- req *connect.Request[v1pb.GetWorksheetRequest],
-) (*connect.Response[v1pb.Worksheet], error) {
- projectID, worksheetID, err := common.GetProjectIDWorksheetID(req.Msg.Name)
+ req *connect.Request[v1pb.GetSavedQueryRequest],
+) (*connect.Response[v1pb.SavedQuery], error) {
+ projectID, savedQueryID, err := common.GetProjectIDSavedQueryID(req.Msg.Name)
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
- worksheet, err := s.findWorksheet(ctx, projectID, worksheetID, true /* loadFull */)
+ savedQuery, err := s.findSavedQuery(ctx, projectID, savedQueryID, true /* loadFull */)
if err != nil {
return nil, err
}
- ok, err := s.canReadWorksheet(ctx, worksheet)
+ ok, err := s.canReadSavedQuery(ctx, savedQuery)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check access with error: %v", err))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot access worksheet %s", worksheet.Title))
+ return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot access saved query %s", savedQuery.Title))
}
- v1pbWorksheet, err := s.convertWorksheetToAPI(ctx, worksheet)
+ v1pbSavedQuery, err := s.convertToAPISavedQuery(ctx, savedQuery)
if err != nil {
return nil, err
}
- return connect.NewResponse(v1pbWorksheet), nil
+ return connect.NewResponse(v1pbSavedQuery), nil
}
-// ListWorksheets returns a list of worksheets.
-func (s *WorksheetService) ListWorksheets(
+// ListSavedQueries returns a list of saved queries.
+func (s *SavedQueryService) ListSavedQueries(
ctx context.Context,
- req *connect.Request[v1pb.ListWorksheetsRequest],
-) (*connect.Response[v1pb.ListWorksheetsResponse], error) {
+ req *connect.Request[v1pb.ListSavedQueriesRequest],
+) (*connect.Response[v1pb.ListSavedQueriesResponse], error) {
request := req.Msg
if request.PageSize < 0 {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("page size must be non-negative: %d", request.PageSize))
@@ -159,7 +161,7 @@ func (s *WorksheetService) ListWorksheets(
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
- worksheetList, err := s.store.ListWorkSheets(ctx, &store.FindWorkSheetMessage{
+ savedQueryList, err := s.store.ListWorkSheets(ctx, &store.FindWorkSheetMessage{
ProjectIDs: projectIDs,
Workspace: workspaceID,
PrincipalEmail: user.Email,
@@ -168,43 +170,43 @@ func (s *WorksheetService) ListWorksheets(
Offset: &offset.offset,
})
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list worksheets: %v", err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list saved queries: %v", err))
}
var nextPageToken string
- if len(worksheetList) == limitPlusOne {
- worksheetList = worksheetList[:offset.limit]
+ if len(savedQueryList) == limitPlusOne {
+ savedQueryList = savedQueryList[:offset.limit]
if nextPageToken, err = offset.getNextPageToken(); err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get next page token"))
}
}
- v1pbWorksheets := make([]*v1pb.Worksheet, 0, len(worksheetList))
- for _, worksheet := range worksheetList {
- v1pbWorksheet, err := s.convertWorksheetToAPI(ctx, worksheet)
+ v1pbSavedQueries := make([]*v1pb.SavedQuery, 0, len(savedQueryList))
+ for _, savedQuery := range savedQueryList {
+ v1pbSavedQuery, err := s.convertToAPISavedQuery(ctx, savedQuery)
if err != nil {
return nil, err
}
- v1pbWorksheets = append(v1pbWorksheets, v1pbWorksheet)
+ v1pbSavedQueries = append(v1pbSavedQueries, v1pbSavedQuery)
}
- return connect.NewResponse(&v1pb.ListWorksheetsResponse{
- Worksheets: v1pbWorksheets,
+ return connect.NewResponse(&v1pb.ListSavedQueriesResponse{
+ SavedQueries: v1pbSavedQueries,
NextPageToken: nextPageToken,
}), nil
}
-// ListWorksheetFolders returns the caller's worksheet folders.
-func (s *WorksheetService) ListWorksheetFolders(
+// ListSavedQueryFolders returns the caller's saved query folders.
+func (s *SavedQueryService) ListSavedQueryFolders(
ctx context.Context,
- req *connect.Request[v1pb.ListWorksheetFoldersRequest],
-) (*connect.Response[v1pb.ListWorksheetFoldersResponse], error) {
+ req *connect.Request[v1pb.ListSavedQueryFoldersRequest],
+) (*connect.Response[v1pb.ListSavedQueryFoldersResponse], error) {
request := req.Msg
projectID, err := common.GetProjectID(request.Parent)
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
if projectID == "-" {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.New(`ListWorksheetFolders does not support parent "projects/-"`))
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.New(`ListSavedQueryFolders does not support parent "projects/-"`))
}
user, ok := GetUserFromContext(ctx)
@@ -218,25 +220,25 @@ func (s *WorksheetService) ListWorksheetFolders(
}
organizerList, err := s.store.ListWorksheetOrganizers(ctx, find)
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list worksheet folders: %v", err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list saved query folders: %v", err))
}
- type worksheetFolder struct {
+ type savedQueryFolder struct {
folders []string
- category v1pb.WorksheetFolder_Category
+ category v1pb.SavedQueryFolder_Category
}
- folderByKey := make(map[string]worksheetFolder)
+ folderByKey := make(map[string]savedQueryFolder)
for _, organizer := range organizerList {
- var category v1pb.WorksheetFolder_Category
+ var category v1pb.SavedQueryFolder_Category
if organizer.WorksheetCreator == user.Email {
- category = v1pb.WorksheetFolder_MINE
+ category = v1pb.SavedQueryFolder_MINE
} else {
- category = v1pb.WorksheetFolder_SHARED
+ category = v1pb.SavedQueryFolder_SHARED
}
for i := range organizer.Payload.Folders {
folders := append([]string(nil), organizer.Payload.Folders[:i+1]...)
key := fmt.Sprintf("%d\x00%s", category, strings.Join(folders, "\x00"))
- folderByKey[key] = worksheetFolder{
+ folderByKey[key] = savedQueryFolder{
folders: folders,
category: category,
}
@@ -248,11 +250,11 @@ func (s *WorksheetService) ListWorksheetFolders(
keys = append(keys, key)
}
slices.Sort(keys)
- response := &v1pb.ListWorksheetFoldersResponse{
- Folders: make([]*v1pb.WorksheetFolder, 0, len(keys)),
+ response := &v1pb.ListSavedQueryFoldersResponse{
+ Folders: make([]*v1pb.SavedQueryFolder, 0, len(keys)),
}
for _, key := range keys {
- response.Folders = append(response.Folders, &v1pb.WorksheetFolder{
+ response.Folders = append(response.Folders, &v1pb.SavedQueryFolder{
Folders: folderByKey[key].folders,
Category: folderByKey[key].category,
})
@@ -260,11 +262,11 @@ func (s *WorksheetService) ListWorksheetFolders(
return connect.NewResponse(response), nil
}
-// SearchWorksheets returns a list of worksheets based on the search filters.
-func (s *WorksheetService) SearchWorksheets(
+// SearchSavedQueries returns a list of saved queries based on the search filters.
+func (s *SavedQueryService) SearchSavedQueries(
ctx context.Context,
- req *connect.Request[v1pb.SearchWorksheetsRequest],
-) (*connect.Response[v1pb.SearchWorksheetsResponse], error) {
+ req *connect.Request[v1pb.SearchSavedQueriesRequest],
+) (*connect.Response[v1pb.SearchSavedQueriesResponse], error) {
request := req.Msg
user, ok := GetUserFromContext(ctx)
if !ok {
@@ -276,7 +278,7 @@ func (s *WorksheetService) SearchWorksheets(
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
if projectID == "-" {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.New(`SearchWorksheets does not support parent "projects/-"`))
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.New(`SearchSavedQueries does not support parent "projects/-"`))
}
if request.PageSize < 0 {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("page size cannot be negative"))
@@ -292,7 +294,7 @@ func (s *WorksheetService) SearchWorksheets(
}
limitPlusOne := offset.limit + 1
- worksheetFind := &store.FindWorkSheetMessage{
+ savedQueryFind := &store.FindWorkSheetMessage{
ProjectIDs: []string{projectID},
PrincipalEmail: user.Email,
Limit: &limitPlusOne,
@@ -303,59 +305,59 @@ func (s *WorksheetService) SearchWorksheets(
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
- worksheetFind.FilterQ = filterQ
+ savedQueryFind.FilterQ = filterQ
- worksheetList, err := s.store.ListWorkSheets(ctx, worksheetFind)
+ savedQueryList, err := s.store.ListWorkSheets(ctx, savedQueryFind)
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list worksheets: %v", err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list saved queries: %v", err))
}
nextPageToken := ""
- if len(worksheetList) == limitPlusOne {
+ if len(savedQueryList) == limitPlusOne {
if nextPageToken, err = offset.getNextPageToken(); err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to generate next page token: %v", err))
}
- worksheetList = worksheetList[:offset.limit]
+ savedQueryList = savedQueryList[:offset.limit]
}
- var v1pbWorksheets []*v1pb.Worksheet
- for _, worksheet := range worksheetList {
- ok, err := s.canReadWorksheet(ctx, worksheet)
+ var v1pbSavedQueries []*v1pb.SavedQuery
+ for _, savedQuery := range savedQueryList {
+ ok, err := s.canReadSavedQuery(ctx, savedQuery)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check access with error: %v", err))
}
if !ok {
- slog.Warn("cannot access worksheet", slog.String("name", worksheet.Title))
+ slog.Warn("cannot access saved query", slog.String("name", savedQuery.Title))
continue
}
- v1pbWorksheet, err := s.convertWorksheetToAPI(ctx, worksheet)
+ v1pbSavedQuery, err := s.convertToAPISavedQuery(ctx, savedQuery)
if err != nil {
return nil, err
}
- v1pbWorksheets = append(v1pbWorksheets, v1pbWorksheet)
+ v1pbSavedQueries = append(v1pbSavedQueries, v1pbSavedQuery)
}
- return connect.NewResponse(&v1pb.SearchWorksheetsResponse{
- Worksheets: v1pbWorksheets,
+ return connect.NewResponse(&v1pb.SearchSavedQueriesResponse{
+ SavedQueries: v1pbSavedQueries,
NextPageToken: nextPageToken,
}), nil
}
-// UpdateWorksheet updates a worksheet.
-func (s *WorksheetService) UpdateWorksheet(
+// UpdateSavedQuery updates a saved query.
+func (s *SavedQueryService) UpdateSavedQuery(
ctx context.Context,
- req *connect.Request[v1pb.UpdateWorksheetRequest],
-) (*connect.Response[v1pb.Worksheet], error) {
+ req *connect.Request[v1pb.UpdateSavedQueryRequest],
+) (*connect.Response[v1pb.SavedQuery], error) {
request := req.Msg
- if request.Worksheet == nil {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("worksheet cannot be empty"))
+ if request.SavedQuery == nil {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("saved query cannot be empty"))
}
if request.UpdateMask == nil {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("update mask cannot be empty"))
}
- if request.Worksheet.Name == "" {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("worksheet name cannot be empty"))
+ if request.SavedQuery.Name == "" {
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("saved query name cannot be empty"))
}
- projectID, worksheetID, err := common.GetProjectIDWorksheetID(request.Worksheet.Name)
+ projectID, savedQueryID, err := common.GetProjectIDSavedQueryID(request.SavedQuery.Name)
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
@@ -364,162 +366,162 @@ func (s *WorksheetService) UpdateWorksheet(
if !ok {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("user not found"))
}
- worksheet, err := s.findWorksheet(ctx, projectID, worksheetID, false /* loadFull */)
+ savedQuery, err := s.findSavedQuery(ctx, projectID, savedQueryID, false /* loadFull */)
if err != nil {
return nil, err
}
- ok, err = s.canWriteWorksheet(ctx, worksheet)
+ ok, err = s.canWriteSavedQuery(ctx, savedQuery)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check access with error: %v", err))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot write worksheet %s", worksheet.Title))
+ return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot write saved query %s", savedQuery.Title))
}
- worksheetPatch := &store.PatchWorkSheetMessage{
- ResourceID: worksheet.ResourceID,
+ savedQueryPatch := &store.PatchWorkSheetMessage{
+ ResourceID: savedQuery.ResourceID,
}
for _, path := range request.UpdateMask.Paths {
switch path {
case "title":
- worksheetPatch.Title = &request.Worksheet.Title
+ savedQueryPatch.Title = &request.SavedQuery.Title
case "content":
- statement := string(request.Worksheet.Content)
- worksheetPatch.Statement = &statement
+ statement := string(request.SavedQuery.Content)
+ savedQueryPatch.Statement = &statement
case "visibility":
- visibility, err := convertToStoreWorksheetVisibility(request.Worksheet.Visibility)
+ visibility, err := convertToStoreWorkSheetVisibility(request.SavedQuery.Visibility)
if err != nil {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid visibility %q", request.Worksheet.Visibility))
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid visibility %q", request.SavedQuery.Visibility))
}
stringVisibility := string(visibility)
- worksheetPatch.Visibility = &stringVisibility
+ savedQueryPatch.Visibility = &stringVisibility
case "database":
- if request.Worksheet.Database != "" {
- database, err := s.getWorksheetDatabase(ctx, worksheet.ProjectID, request.Worksheet.Database)
+ if request.SavedQuery.Database != "" {
+ database, err := s.getSavedQueryDatabase(ctx, savedQuery.ProjectID, request.SavedQuery.Database)
if err != nil {
return nil, err
}
- worksheetPatch.InstanceID, worksheetPatch.DatabaseName = &database.InstanceID, &database.DatabaseName
+ savedQueryPatch.InstanceID, savedQueryPatch.DatabaseName = &database.InstanceID, &database.DatabaseName
} else {
emptyStr := ""
- worksheetPatch.InstanceID = &emptyStr
- worksheetPatch.DatabaseName = &emptyStr
+ savedQueryPatch.InstanceID = &emptyStr
+ savedQueryPatch.DatabaseName = &emptyStr
}
default:
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid update mask path %q", path))
}
}
- if err := s.store.PatchWorkSheet(ctx, worksheetPatch); err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to update worksheet: %v", err))
+ if err := s.store.PatchWorkSheet(ctx, savedQueryPatch); err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to update saved query: %v", err))
}
- worksheet, err = s.store.GetWorkSheet(ctx, &store.FindWorkSheetMessage{
- ProjectIDs: []string{worksheet.ProjectID},
- ResourceID: &worksheetID,
+ savedQuery, err = s.store.GetWorkSheet(ctx, &store.FindWorkSheetMessage{
+ ProjectIDs: []string{savedQuery.ProjectID},
+ ResourceID: &savedQueryID,
PrincipalEmail: user.Email,
})
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to get worksheet: %v", err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to get saved query: %v", err))
}
- if worksheet == nil {
- return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("worksheet %q not found", request.Worksheet.Name))
+ if savedQuery == nil {
+ return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("saved query %q not found", request.SavedQuery.Name))
}
- v1pbWorksheet, err := s.convertWorksheetToAPI(ctx, worksheet)
+ v1pbSavedQuery, err := s.convertToAPISavedQuery(ctx, savedQuery)
if err != nil {
return nil, err
}
- return connect.NewResponse(v1pbWorksheet), nil
+ return connect.NewResponse(v1pbSavedQuery), nil
}
-// DeleteWorksheet deletes a worksheet.
-func (s *WorksheetService) DeleteWorksheet(
+// DeleteSavedQuery deletes a saved query.
+func (s *SavedQueryService) DeleteSavedQuery(
ctx context.Context,
- req *connect.Request[v1pb.DeleteWorksheetRequest],
+ req *connect.Request[v1pb.DeleteSavedQueryRequest],
) (*connect.Response[emptypb.Empty], error) {
- projectID, worksheetID, err := common.GetProjectIDWorksheetID(req.Msg.Name)
+ projectID, savedQueryID, err := common.GetProjectIDSavedQueryID(req.Msg.Name)
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
- worksheet, err := s.findWorksheet(ctx, projectID, worksheetID, false /* loadFull */)
+ savedQuery, err := s.findSavedQuery(ctx, projectID, savedQueryID, false /* loadFull */)
if err != nil {
return nil, err
}
- ok, err := s.canWriteWorksheet(ctx, worksheet)
+ ok, err := s.canWriteSavedQuery(ctx, savedQuery)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check access with error: %v", err))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot write worksheet %s", worksheet.Title))
+ return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot write saved query %s", savedQuery.Title))
}
- if err := s.store.DeleteWorkSheet(ctx, worksheet.ResourceID); err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to delete worksheet: %v", err))
+ if err := s.store.DeleteWorkSheet(ctx, savedQuery.ResourceID); err != nil {
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to delete saved query: %v", err))
}
return connect.NewResponse(&emptypb.Empty{}), nil
}
-// UpdateWorksheetOrganizer upsert the worksheet organizer.
-func (s *WorksheetService) UpdateWorksheetOrganizer(
+// UpdateSavedQueryOrganizer upsert the saved query organizer.
+func (s *SavedQueryService) UpdateSavedQueryOrganizer(
ctx context.Context,
- req *connect.Request[v1pb.UpdateWorksheetOrganizerRequest],
-) (*connect.Response[v1pb.WorksheetOrganizer], error) {
+ req *connect.Request[v1pb.UpdateSavedQueryOrganizerRequest],
+) (*connect.Response[v1pb.SavedQueryOrganizer], error) {
request := req.Msg
- projectID, worksheetID, err := common.GetProjectIDWorksheetID(request.Organizer.Worksheet)
+ projectID, savedQueryID, err := common.GetProjectIDSavedQueryID(request.Organizer.SavedQuery)
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
- worksheet, err := s.findWorksheet(ctx, projectID, worksheetID, false /* loadFull */)
+ savedQuery, err := s.findSavedQuery(ctx, projectID, savedQueryID, false /* loadFull */)
if err != nil {
return nil, err
}
- ok, err := s.canReadWorksheet(ctx, worksheet)
+ ok, err := s.canReadSavedQuery(ctx, savedQuery)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check access with error: %v", err))
}
if !ok {
- return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot access worksheet %s", worksheet.Title))
+ return nil, connect.NewError(connect.CodePermissionDenied, errors.Errorf("cannot access saved query %s", savedQuery.Title))
}
user, ok := GetUserFromContext(ctx)
if !ok {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("user not found"))
}
- worksheetOrganizerUpsert, err := s.store.GetWorksheetOrganizer(ctx, worksheet.ResourceID, user.Email)
+ savedQueryOrganizerUpsert, err := s.store.GetWorksheetOrganizer(ctx, savedQuery.ResourceID, user.Email)
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to found worksheet organizer with error: %v", err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to found saved query organizer with error: %v", err))
}
for _, path := range request.UpdateMask.Paths {
switch path {
case "starred":
- worksheetOrganizerUpsert.Payload.Starred = request.Organizer.Starred
+ savedQueryOrganizerUpsert.Payload.Starred = request.Organizer.Starred
case "folders":
- worksheetOrganizerUpsert.Payload.Folders = request.Organizer.Folders
+ savedQueryOrganizerUpsert.Payload.Folders = request.Organizer.Folders
default:
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid update mask path %q", path))
}
}
- organizer, err := s.store.UpsertWorksheetOrganizer(ctx, worksheetOrganizerUpsert)
+ organizer, err := s.store.UpsertWorksheetOrganizer(ctx, savedQueryOrganizerUpsert)
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to upsert organizer for worksheet %s with error: %v", request.Organizer.Worksheet, err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to upsert organizer for saved query %s with error: %v", request.Organizer.SavedQuery, err))
}
- return connect.NewResponse(&v1pb.WorksheetOrganizer{
- Worksheet: request.Organizer.Worksheet,
- Starred: organizer.Payload.Starred,
- Folders: organizer.Payload.Folders,
+ return connect.NewResponse(&v1pb.SavedQueryOrganizer{
+ SavedQuery: request.Organizer.SavedQuery,
+ Starred: organizer.Payload.Starred,
+ Folders: organizer.Payload.Folders,
}), nil
}
-func (s *WorksheetService) BatchUpdateWorksheetOrganizer(
+func (s *SavedQueryService) BatchUpdateSavedQueryOrganizer(
ctx context.Context,
- req *connect.Request[v1pb.BatchUpdateWorksheetOrganizerRequest],
-) (*connect.Response[v1pb.BatchUpdateWorksheetOrganizerResponse], error) {
+ req *connect.Request[v1pb.BatchUpdateSavedQueryOrganizerRequest],
+) (*connect.Response[v1pb.BatchUpdateSavedQueryOrganizerResponse], error) {
request := req.Msg
if request.Organizer == nil {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("organizer cannot be empty"))
@@ -536,7 +538,7 @@ func (s *WorksheetService) BatchUpdateWorksheetOrganizer(
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
if projectID == "-" {
- return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("projects/- is not supported for batch update worksheet organizers"))
+ return nil, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("projects/- is not supported for batch update saved query organizers"))
}
user, ok := GetUserFromContext(ctx)
@@ -548,30 +550,30 @@ func (s *WorksheetService) BatchUpdateWorksheetOrganizer(
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, err)
}
- worksheetList, err := s.store.ListWorkSheets(ctx, &store.FindWorkSheetMessage{
+ savedQueryList, err := s.store.ListWorkSheets(ctx, &store.FindWorkSheetMessage{
ProjectIDs: []string{projectID},
PrincipalEmail: user.Email,
FilterQ: filterQ,
})
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list worksheets: %v", err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to list saved queries: %v", err))
}
- var worksheetIDs []string
- for _, worksheet := range worksheetList {
- ok, err := s.canReadWorksheet(ctx, worksheet)
+ var savedQueryIDs []string
+ for _, savedQuery := range savedQueryList {
+ ok, err := s.canReadSavedQuery(ctx, savedQuery)
if err != nil {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to check access with error: %v", err))
}
if !ok {
- slog.Warn("cannot access worksheet", slog.String("name", worksheet.Title))
+ slog.Warn("cannot access saved query", slog.String("name", savedQuery.Title))
continue
}
- worksheetIDs = append(worksheetIDs, worksheet.ResourceID)
+ savedQueryIDs = append(savedQueryIDs, savedQuery.ResourceID)
}
patch := &store.BatchUpdateWorksheetOrganizerPatch{
- WorksheetResourceIDs: worksheetIDs,
+ WorksheetResourceIDs: savedQueryIDs,
Principal: user.Email,
}
for _, path := range request.UpdateMask.Paths {
@@ -589,42 +591,42 @@ func (s *WorksheetService) BatchUpdateWorksheetOrganizer(
organizers, err := s.store.BatchUpdateWorksheetOrganizer(ctx, patch)
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to batch update worksheet organizers: %v", err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to batch update saved query organizers: %v", err))
}
- response := &v1pb.BatchUpdateWorksheetOrganizerResponse{
+ response := &v1pb.BatchUpdateSavedQueryOrganizerResponse{
UpdatedCount: int32(len(organizers)),
}
for _, organizer := range organizers {
- response.WorksheetOrganizers = append(response.WorksheetOrganizers, &v1pb.WorksheetOrganizer{
- Worksheet: fmt.Sprintf("%s/worksheets/%s", request.Parent, organizer.WorksheetResourceID),
- Starred: organizer.Payload.Starred,
- Folders: organizer.Payload.Folders,
+ response.SavedQueryOrganizers = append(response.SavedQueryOrganizers, &v1pb.SavedQueryOrganizer{
+ SavedQuery: fmt.Sprintf("%s/savedQueries/%s", request.Parent, organizer.WorksheetResourceID),
+ Starred: organizer.Payload.Starred,
+ Folders: organizer.Payload.Folders,
})
}
return connect.NewResponse(response), nil
}
-func (s *WorksheetService) findWorksheet(ctx context.Context, projectID string, worksheetID string, loadFull bool) (*store.WorkSheetMessage, error) {
+func (s *SavedQueryService) findSavedQuery(ctx context.Context, projectID string, savedQueryID string, loadFull bool) (*store.WorkSheetMessage, error) {
user, ok := GetUserFromContext(ctx)
if !ok {
return nil, connect.NewError(connect.CodeInternal, errors.Errorf("user not found"))
}
- worksheet, err := s.store.GetWorkSheet(ctx, &store.FindWorkSheetMessage{
+ savedQuery, err := s.store.GetWorkSheet(ctx, &store.FindWorkSheetMessage{
ProjectIDs: []string{projectID},
- ResourceID: &worksheetID,
+ ResourceID: &savedQueryID,
LoadFull: loadFull,
PrincipalEmail: user.Email,
})
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to get worksheet: %v", err))
+ return nil, connect.NewError(connect.CodeInternal, errors.Errorf("failed to get saved query: %v", err))
}
- if worksheet == nil {
- return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("cannot find the worksheet"))
+ if savedQuery == nil {
+ return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("cannot find the saved query"))
}
- return worksheet, nil
+ return savedQuery, nil
}
-func (s *WorksheetService) getWorksheetDatabase(ctx context.Context, projectID, name string) (*store.DatabaseMessage, error) {
+func (s *SavedQueryService) getSavedQueryDatabase(ctx context.Context, projectID, name string) (*store.DatabaseMessage, error) {
targetProjectID, instanceID, databaseName, err := common.GetDatabaseResourceName(name)
if err != nil {
return nil, connect.NewError(connect.CodeInvalidArgument, errors.Wrapf(err, "failed to parse %q", name))
@@ -660,18 +662,18 @@ func (s *WorksheetService) getWorksheetDatabase(ctx context.Context, projectID,
return database, nil
}
-// canWriteWorksheet check if the principal can write the worksheet.
-// worksheet is writable when the user has bb.worksheets.manage permission on the workspace, or.
+// canWriteSavedQuery check if the principal can write the saved query.
+// The saved query is writable when the user has bb.worksheets.manage permission on the workspace, or.
// PRIVATE: the creator.
// PROJECT_WRITE: all members with bb.projects.get permission in the project.
-func (s *WorksheetService) canWriteWorksheet(ctx context.Context, worksheet *store.WorkSheetMessage) (bool, error) {
+func (s *SavedQueryService) canWriteSavedQuery(ctx context.Context, savedQuery *store.WorkSheetMessage) (bool, error) {
user, ok := GetUserFromContext(ctx)
if !ok {
return false, connect.NewError(connect.CodeInternal, errors.Errorf("user not found"))
}
- // Worksheet creator and workspace "bb.worksheets.manage" can always write.
- if worksheet.Creator == user.Email {
+ // The saved query creator and workspace "bb.worksheets.manage" can always write.
+ if savedQuery.Creator == user.Email {
return true, nil
}
ok, err := s.iamManager.CheckPermission(ctx, permission.WorksheetsManage, user, common.GetWorkspaceIDFromContext(ctx))
@@ -682,33 +684,33 @@ func (s *WorksheetService) canWriteWorksheet(ctx context.Context, worksheet *sto
return true, nil
}
- switch worksheet.Visibility {
+ switch savedQuery.Visibility {
case store.PrivateWorkSheet:
return false, nil
case store.ProjectReadWorkSheet:
// For READ visibility, check the "bb.worksheets.manage" permission in the project.
- return s.checkWorksheetPermission(ctx, worksheet.ProjectID, user, permission.WorksheetsManage)
+ return s.checkSavedQueryPermission(ctx, savedQuery.ProjectID, user, permission.WorksheetsManage)
case store.ProjectWriteWorkSheet:
// For READ visibility, needs "bb.worksheets.get" permission in the project.
- return s.checkWorksheetPermission(ctx, worksheet.ProjectID, user, permission.WorksheetsGet)
+ return s.checkSavedQueryPermission(ctx, savedQuery.ProjectID, user, permission.WorksheetsGet)
default:
return false, nil
}
}
-// canReadWorksheet check if the principal can read the worksheet.
-// worksheet is readable when the user has bb.worksheets.get permission on the workspace, or.
+// canReadSavedQuery check if the principal can read the saved query.
+// The saved query is readable when the user has bb.worksheets.get permission on the workspace, or.
// PRIVATE: the creator only.
// PROJECT_WRITE: all members with bb.projects.get permission in the project.
// PROJECT_READ: all members with bb.projects.get permission in the project.
-func (s *WorksheetService) canReadWorksheet(ctx context.Context, worksheet *store.WorkSheetMessage) (bool, error) {
+func (s *SavedQueryService) canReadSavedQuery(ctx context.Context, savedQuery *store.WorkSheetMessage) (bool, error) {
user, ok := GetUserFromContext(ctx)
if !ok {
return false, connect.NewError(connect.CodeInternal, errors.Errorf("user not found"))
}
- // Worksheet creator and workspace bb.worksheets.get can always read.
- if worksheet.Creator == user.Email {
+ // The saved query creator and workspace bb.worksheets.get can always read.
+ if savedQuery.Creator == user.Email {
return true, nil
}
ok, err := s.iamManager.CheckPermission(ctx, permission.WorksheetsManage, user, common.GetWorkspaceIDFromContext(ctx))
@@ -719,18 +721,18 @@ func (s *WorksheetService) canReadWorksheet(ctx context.Context, worksheet *stor
return true, nil
}
- switch worksheet.Visibility {
+ switch savedQuery.Visibility {
case store.PrivateWorkSheet:
return false, nil
case store.ProjectReadWorkSheet, store.ProjectWriteWorkSheet:
// Check the "bb.worksheets.get" permission in the project.
- return s.checkWorksheetPermission(ctx, worksheet.ProjectID, user, permission.WorksheetsGet)
+ return s.checkSavedQueryPermission(ctx, savedQuery.ProjectID, user, permission.WorksheetsGet)
default:
return false, nil
}
}
-func (s *WorksheetService) checkWorksheetPermission(
+func (s *SavedQueryService) checkSavedQueryPermission(
ctx context.Context,
projectID string,
user *store.UserMessage,
@@ -751,54 +753,54 @@ func (s *WorksheetService) checkWorksheetPermission(
return ok, nil
}
-func (s *WorksheetService) convertWorksheetToAPI(ctx context.Context, worksheet *store.WorkSheetMessage) (*v1pb.Worksheet, error) {
+func (s *SavedQueryService) convertToAPISavedQuery(ctx context.Context, savedQuery *store.WorkSheetMessage) (*v1pb.SavedQuery, error) {
databaseParent := ""
- if worksheet.InstanceID != nil && worksheet.DatabaseName != nil {
+ if savedQuery.InstanceID != nil && savedQuery.DatabaseName != nil {
instance, err := s.store.GetInstance(ctx, &store.FindInstanceMessage{
Workspace: common.GetWorkspaceIDFromContext(ctx),
- ResourceID: worksheet.InstanceID,
+ ResourceID: savedQuery.InstanceID,
})
if err != nil {
- return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get worksheet instance %q", *worksheet.InstanceID))
+ return nil, connect.NewError(connect.CodeInternal, errors.Wrapf(err, "failed to get saved query instance %q", *savedQuery.InstanceID))
}
if instance == nil {
- return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("worksheet instance %q not found", *worksheet.InstanceID))
+ return nil, connect.NewError(connect.CodeNotFound, errors.Errorf("saved query instance %q not found", *savedQuery.InstanceID))
}
- databaseParent = common.FormatDatabase(*worksheet.InstanceID, *worksheet.DatabaseName)
+ databaseParent = common.FormatDatabase(*savedQuery.InstanceID, *savedQuery.DatabaseName)
if instance.ProjectID != nil {
- databaseParent = common.FormatProjectDatabase(*instance.ProjectID, *worksheet.InstanceID, *worksheet.DatabaseName)
+ databaseParent = common.FormatProjectDatabase(*instance.ProjectID, *savedQuery.InstanceID, *savedQuery.DatabaseName)
}
}
- visibility := v1pb.Worksheet_VISIBILITY_UNSPECIFIED
- switch worksheet.Visibility {
+ visibility := v1pb.SavedQuery_VISIBILITY_UNSPECIFIED
+ switch savedQuery.Visibility {
case store.ProjectReadWorkSheet:
- visibility = v1pb.Worksheet_PROJECT_READ
+ visibility = v1pb.SavedQuery_PROJECT_READ
case store.ProjectWriteWorkSheet:
- visibility = v1pb.Worksheet_PROJECT_WRITE
+ visibility = v1pb.SavedQuery_PROJECT_WRITE
case store.PrivateWorkSheet:
- visibility = v1pb.Worksheet_PRIVATE
+ visibility = v1pb.SavedQuery_PRIVATE
default:
// Keep VISIBILITY_UNSPECIFIED
}
- return &v1pb.Worksheet{
- Name: common.FormatWorksheet(worksheet.ProjectID, worksheet.ResourceID),
- Project: common.FormatProject(worksheet.ProjectID),
+ return &v1pb.SavedQuery{
+ Name: common.FormatSavedQuery(savedQuery.ProjectID, savedQuery.ResourceID),
+ Project: common.FormatProject(savedQuery.ProjectID),
Database: databaseParent,
- Title: worksheet.Title,
- Creator: fmt.Sprintf("users/%s", worksheet.Creator),
- CreateTime: timestamppb.New(worksheet.CreatedAt),
- UpdateTime: timestamppb.New(worksheet.UpdatedAt),
- Content: []byte(worksheet.Statement),
- ContentSize: worksheet.Size,
+ Title: savedQuery.Title,
+ Creator: fmt.Sprintf("users/%s", savedQuery.Creator),
+ CreateTime: timestamppb.New(savedQuery.CreatedAt),
+ UpdateTime: timestamppb.New(savedQuery.UpdatedAt),
+ Content: []byte(savedQuery.Statement),
+ ContentSize: savedQuery.Size,
Visibility: visibility,
- Starred: worksheet.Starred,
- Folders: worksheet.Folders,
+ Starred: savedQuery.Starred,
+ Folders: savedQuery.Folders,
}, nil
}
-func convertToStoreWorksheetMessage(project *store.ProjectMessage, database *store.DatabaseMessage, creator string, worksheet *v1pb.Worksheet) (*store.WorkSheetMessage, error) {
- visibility, err := convertToStoreWorksheetVisibility(worksheet.Visibility)
+func convertToStoreWorkSheetMessage(project *store.ProjectMessage, database *store.DatabaseMessage, creator string, savedQuery *v1pb.SavedQuery) (*store.WorkSheetMessage, error) {
+ visibility, err := convertToStoreWorkSheetVisibility(savedQuery.Visibility)
if err != nil {
return nil, err
}
@@ -806,8 +808,8 @@ func convertToStoreWorksheetMessage(project *store.ProjectMessage, database *sto
worksheetMessage := &store.WorkSheetMessage{
ProjectID: project.ResourceID,
Creator: creator,
- Title: worksheet.Title,
- Statement: string(worksheet.Content),
+ Title: savedQuery.Title,
+ Statement: string(savedQuery.Content),
Visibility: visibility,
}
if database != nil {
@@ -818,15 +820,15 @@ func convertToStoreWorksheetMessage(project *store.ProjectMessage, database *sto
return worksheetMessage, nil
}
-func convertToStoreWorksheetVisibility(visibility v1pb.Worksheet_Visibility) (store.WorkSheetVisibility, error) {
+func convertToStoreWorkSheetVisibility(visibility v1pb.SavedQuery_Visibility) (store.WorkSheetVisibility, error) {
switch visibility {
- case v1pb.Worksheet_VISIBILITY_UNSPECIFIED:
+ case v1pb.SavedQuery_VISIBILITY_UNSPECIFIED:
return store.WorkSheetVisibility(""), connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid visibility %q", visibility))
- case v1pb.Worksheet_PROJECT_READ:
+ case v1pb.SavedQuery_PROJECT_READ:
return store.ProjectReadWorkSheet, nil
- case v1pb.Worksheet_PROJECT_WRITE:
+ case v1pb.SavedQuery_PROJECT_WRITE:
return store.ProjectWriteWorkSheet, nil
- case v1pb.Worksheet_PRIVATE:
+ case v1pb.SavedQuery_PRIVATE:
return store.PrivateWorkSheet, nil
default:
return store.WorkSheetVisibility(""), connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid visibility %q", visibility))
diff --git a/backend/common/resource_name.go b/backend/common/resource_name.go
index 69f149a3b4..b4f7d3754c 100644
--- a/backend/common/resource_name.go
+++ b/backend/common/resource_name.go
@@ -34,7 +34,7 @@ const (
RolePrefix = "roles/"
WebhookIDPrefix = "webhooks/"
SheetIDPrefix = "sheets/"
- WorksheetIDPrefix = "worksheets/"
+ SavedQueryIDPrefix = "savedQueries/"
DatabaseGroupNamePrefix = "databaseGroups/"
SchemaNamePrefix = "schemas/"
TableNamePrefix = "tables/"
@@ -526,20 +526,20 @@ func GetProjectResourceIDSheetSha256(name string) (string, string, error) {
return tokens[0], strings.ToLower(tokens[1]), nil
}
-// GetProjectIDWorksheetID returns the project ID and worksheet ID (resource_id) from a resource name.
-// Format: projects/{project}/worksheets/{worksheet}
-func GetProjectIDWorksheetID(name string) (string, string, error) {
- tokens, err := GetNameParentTokens(name, ProjectNamePrefix, WorksheetIDPrefix)
+// GetProjectIDSavedQueryID returns the project ID and saved query ID (resource_id) from a resource name.
+// Format: projects/{project}/savedQueries/{savedQuery}
+func GetProjectIDSavedQueryID(name string) (string, string, error) {
+ tokens, err := GetNameParentTokens(name, ProjectNamePrefix, SavedQueryIDPrefix)
if err != nil {
return "", "", err
}
return tokens[0], tokens[1], nil
}
-// FormatWorksheet formats a worksheet resource name.
-// Format: projects/{project}/worksheets/{worksheet}
-func FormatWorksheet(projectID, worksheetID string) string {
- return fmt.Sprintf("%s/%s%s", FormatProject(projectID), WorksheetIDPrefix, worksheetID)
+// FormatSavedQuery formats a saved query resource name.
+// Format: projects/{project}/savedQueries/{savedQuery}
+func FormatSavedQuery(projectID, savedQueryID string) string {
+ return fmt.Sprintf("%s/%s%s", FormatProject(projectID), SavedQueryIDPrefix, savedQueryID)
}
// GetReviewConfigID returns the review config id from a resource name.
diff --git a/backend/generated-go/v1/saved_query_service.pb.go b/backend/generated-go/v1/saved_query_service.pb.go
new file mode 100644
index 0000000000..f0319088fe
--- /dev/null
+++ b/backend/generated-go/v1/saved_query_service.pb.go
@@ -0,0 +1,1413 @@
+// Code generated by protoc-gen-go. DO NOT EDIT.
+// versions:
+// protoc-gen-go v1.36.12
+// protoc (unknown)
+// source: v1/saved_query_service.proto
+
+package v1
+
+import (
+ _ "buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go/buf/validate"
+ _ "google.golang.org/genproto/googleapis/api/annotations"
+ protoreflect "google.golang.org/protobuf/reflect/protoreflect"
+ protoimpl "google.golang.org/protobuf/runtime/protoimpl"
+ emptypb "google.golang.org/protobuf/types/known/emptypb"
+ fieldmaskpb "google.golang.org/protobuf/types/known/fieldmaskpb"
+ timestamppb "google.golang.org/protobuf/types/known/timestamppb"
+ 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 SavedQueryFolder_Category int32
+
+const (
+ SavedQueryFolder_CATEGORY_UNSPECIFIED SavedQueryFolder_Category = 0
+ SavedQueryFolder_MINE SavedQueryFolder_Category = 1
+ SavedQueryFolder_SHARED SavedQueryFolder_Category = 2
+)
+
+// Enum value maps for SavedQueryFolder_Category.
+var (
+ SavedQueryFolder_Category_name = map[int32]string{
+ 0: "CATEGORY_UNSPECIFIED",
+ 1: "MINE",
+ 2: "SHARED",
+ }
+ SavedQueryFolder_Category_value = map[string]int32{
+ "CATEGORY_UNSPECIFIED": 0,
+ "MINE": 1,
+ "SHARED": 2,
+ }
+)
+
+func (x SavedQueryFolder_Category) Enum() *SavedQueryFolder_Category {
+ p := new(SavedQueryFolder_Category)
+ *p = x
+ return p
+}
+
+func (x SavedQueryFolder_Category) String() string {
+ return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
+}
+
+func (SavedQueryFolder_Category) Descriptor() protoreflect.EnumDescriptor {
+ return file_v1_saved_query_service_proto_enumTypes[0].Descriptor()
+}
+
+func (SavedQueryFolder_Category) Type() protoreflect.EnumType {
+ return &file_v1_saved_query_service_proto_enumTypes[0]
+}
+
+func (x SavedQueryFolder_Category) Number() protoreflect.EnumNumber {
+ return protoreflect.EnumNumber(x)
+}
+
+// Deprecated: Use SavedQueryFolder_Category.Descriptor instead.
+func (SavedQueryFolder_Category) EnumDescriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{6, 0}
+}
+
+type SavedQuery_Visibility int32
+
+const (
+ SavedQuery_VISIBILITY_UNSPECIFIED SavedQuery_Visibility = 0
+ // Read access in project scope, saved query OWNER/DBA and project OWNER can read/write, other project members can read.
+ SavedQuery_PROJECT_READ SavedQuery_Visibility = 1
+ // Write access in project scope, saved query OWNER/DBA and all members in the project can write the saved query.
+ SavedQuery_PROJECT_WRITE SavedQuery_Visibility = 2
+ // Private, only saved query OWNER can read/write.
+ SavedQuery_PRIVATE SavedQuery_Visibility = 3
+)
+
+// Enum value maps for SavedQuery_Visibility.
+var (
+ SavedQuery_Visibility_name = map[int32]string{
+ 0: "VISIBILITY_UNSPECIFIED",
+ 1: "PROJECT_READ",
+ 2: "PROJECT_WRITE",
+ 3: "PRIVATE",
+ }
+ SavedQuery_Visibility_value = map[string]int32{
+ "VISIBILITY_UNSPECIFIED": 0,
+ "PROJECT_READ": 1,
+ "PROJECT_WRITE": 2,
+ "PRIVATE": 3,
+ }
+)
+
+func (x SavedQuery_Visibility) Enum() *SavedQuery_Visibility {
+ p := new(SavedQuery_Visibility)
+ *p = x
+ return p
+}
+
+func (x SavedQuery_Visibility) String() string {
+ return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
+}
+
+func (SavedQuery_Visibility) Descriptor() protoreflect.EnumDescriptor {
+ return file_v1_saved_query_service_proto_enumTypes[1].Descriptor()
+}
+
+func (SavedQuery_Visibility) Type() protoreflect.EnumType {
+ return &file_v1_saved_query_service_proto_enumTypes[1]
+}
+
+func (x SavedQuery_Visibility) Number() protoreflect.EnumNumber {
+ return protoreflect.EnumNumber(x)
+}
+
+// Deprecated: Use SavedQuery_Visibility.Descriptor instead.
+func (SavedQuery_Visibility) EnumDescriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{15, 0}
+}
+
+type CreateSavedQueryRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The parent resource where this saved query will be created.
+ // Format: projects/{project}
+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
+ // The saved query to create.
+ SavedQuery *SavedQuery `protobuf:"bytes,2,opt,name=saved_query,json=savedQuery,proto3" json:"saved_query,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *CreateSavedQueryRequest) Reset() {
+ *x = CreateSavedQueryRequest{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[0]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *CreateSavedQueryRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*CreateSavedQueryRequest) ProtoMessage() {}
+
+func (x *CreateSavedQueryRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_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 CreateSavedQueryRequest.ProtoReflect.Descriptor instead.
+func (*CreateSavedQueryRequest) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{0}
+}
+
+func (x *CreateSavedQueryRequest) GetParent() string {
+ if x != nil {
+ return x.Parent
+ }
+ return ""
+}
+
+func (x *CreateSavedQueryRequest) GetSavedQuery() *SavedQuery {
+ if x != nil {
+ return x.SavedQuery
+ }
+ return nil
+}
+
+type GetSavedQueryRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The name of the saved query to retrieve.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *GetSavedQueryRequest) Reset() {
+ *x = GetSavedQueryRequest{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[1]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *GetSavedQueryRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*GetSavedQueryRequest) ProtoMessage() {}
+
+func (x *GetSavedQueryRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[1]
+ 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 GetSavedQueryRequest.ProtoReflect.Descriptor instead.
+func (*GetSavedQueryRequest) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{1}
+}
+
+func (x *GetSavedQueryRequest) GetName() string {
+ if x != nil {
+ return x.Name
+ }
+ return ""
+}
+
+type ListSavedQueriesRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The parent resource of the saved queries.
+ // Format: projects/{project}
+ // Use "projects/-" to list saved queries across all projects.
+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
+ // To filter the list result.
+ // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ //
+ // Supported filter:
+ // - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ //
+ // For example:
+ // creator == "users/{email}"
+ // creator != "users/{email}"
+ Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
+ // The maximum number of saved queries to return. The service may return fewer than
+ // this value.
+ // If unspecified, at most 10 saved queries will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
+ // A page token, received from a previous `ListSavedQueries` call.
+ // Provide this to retrieve the subsequent page.
+ //
+ // When paginating, all other parameters provided to `ListSavedQueries` must match
+ // the call that provided the page token.
+ PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *ListSavedQueriesRequest) Reset() {
+ *x = ListSavedQueriesRequest{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[2]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *ListSavedQueriesRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*ListSavedQueriesRequest) ProtoMessage() {}
+
+func (x *ListSavedQueriesRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[2]
+ 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 ListSavedQueriesRequest.ProtoReflect.Descriptor instead.
+func (*ListSavedQueriesRequest) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{2}
+}
+
+func (x *ListSavedQueriesRequest) GetParent() string {
+ if x != nil {
+ return x.Parent
+ }
+ return ""
+}
+
+func (x *ListSavedQueriesRequest) GetFilter() string {
+ if x != nil {
+ return x.Filter
+ }
+ return ""
+}
+
+func (x *ListSavedQueriesRequest) GetPageSize() int32 {
+ if x != nil {
+ return x.PageSize
+ }
+ return 0
+}
+
+func (x *ListSavedQueriesRequest) GetPageToken() string {
+ if x != nil {
+ return x.PageToken
+ }
+ return ""
+}
+
+type ListSavedQueriesResponse struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The saved queries from the specified parent.
+ SavedQueries []*SavedQuery `protobuf:"bytes,1,rep,name=saved_queries,json=savedQueries,proto3" json:"saved_queries,omitempty"`
+ // A token to retrieve next page of saved queries.
+ // Pass this value in the page_token field in the subsequent call to
+ // `ListSavedQueries` method to retrieve the next page of saved queries.
+ NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *ListSavedQueriesResponse) Reset() {
+ *x = ListSavedQueriesResponse{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[3]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *ListSavedQueriesResponse) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*ListSavedQueriesResponse) ProtoMessage() {}
+
+func (x *ListSavedQueriesResponse) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[3]
+ 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 ListSavedQueriesResponse.ProtoReflect.Descriptor instead.
+func (*ListSavedQueriesResponse) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{3}
+}
+
+func (x *ListSavedQueriesResponse) GetSavedQueries() []*SavedQuery {
+ if x != nil {
+ return x.SavedQueries
+ }
+ return nil
+}
+
+func (x *ListSavedQueriesResponse) GetNextPageToken() string {
+ if x != nil {
+ return x.NextPageToken
+ }
+ return ""
+}
+
+type ListSavedQueryFoldersRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The parent resource of the saved query folders.
+ // Format: projects/{project}
+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *ListSavedQueryFoldersRequest) Reset() {
+ *x = ListSavedQueryFoldersRequest{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[4]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *ListSavedQueryFoldersRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*ListSavedQueryFoldersRequest) ProtoMessage() {}
+
+func (x *ListSavedQueryFoldersRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[4]
+ 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 ListSavedQueryFoldersRequest.ProtoReflect.Descriptor instead.
+func (*ListSavedQueryFoldersRequest) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{4}
+}
+
+func (x *ListSavedQueryFoldersRequest) GetParent() string {
+ if x != nil {
+ return x.Parent
+ }
+ return ""
+}
+
+type ListSavedQueryFoldersResponse struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The caller's saved query folders.
+ Folders []*SavedQueryFolder `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *ListSavedQueryFoldersResponse) Reset() {
+ *x = ListSavedQueryFoldersResponse{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[5]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *ListSavedQueryFoldersResponse) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*ListSavedQueryFoldersResponse) ProtoMessage() {}
+
+func (x *ListSavedQueryFoldersResponse) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[5]
+ 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 ListSavedQueryFoldersResponse.ProtoReflect.Descriptor instead.
+func (*ListSavedQueryFoldersResponse) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{5}
+}
+
+func (x *ListSavedQueryFoldersResponse) GetFolders() []*SavedQueryFolder {
+ if x != nil {
+ return x.Folders
+ }
+ return nil
+}
+
+type SavedQueryFolder struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The folder path segments.
+ Folders []string `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
+ // The folder category.
+ Category SavedQueryFolder_Category `protobuf:"varint,2,opt,name=category,proto3,enum=bytebase.v1.SavedQueryFolder_Category" json:"category,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SavedQueryFolder) Reset() {
+ *x = SavedQueryFolder{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[6]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SavedQueryFolder) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SavedQueryFolder) ProtoMessage() {}
+
+func (x *SavedQueryFolder) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[6]
+ 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 SavedQueryFolder.ProtoReflect.Descriptor instead.
+func (*SavedQueryFolder) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{6}
+}
+
+func (x *SavedQueryFolder) GetFolders() []string {
+ if x != nil {
+ return x.Folders
+ }
+ return nil
+}
+
+func (x *SavedQueryFolder) GetCategory() SavedQueryFolder_Category {
+ if x != nil {
+ return x.Category
+ }
+ return SavedQueryFolder_CATEGORY_UNSPECIFIED
+}
+
+type UpdateSavedQueryRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The saved query to update.
+ //
+ // The saved query's `name` field is used to identify the saved query to update.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ SavedQuery *SavedQuery `protobuf:"bytes,1,opt,name=saved_query,json=savedQuery,proto3" json:"saved_query,omitempty"`
+ // The list of fields to be updated.
+ // Fields are specified relative to the saved query.
+ // (e.g., `title`, `statement`; *not* `saved_query.title` or `saved_query.statement`)
+ // Only support update the following fields for now:
+ // - `title`
+ // - `statement`
+ // - `starred`
+ // - `visibility`
+ UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *UpdateSavedQueryRequest) Reset() {
+ *x = UpdateSavedQueryRequest{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[7]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *UpdateSavedQueryRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*UpdateSavedQueryRequest) ProtoMessage() {}
+
+func (x *UpdateSavedQueryRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[7]
+ 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 UpdateSavedQueryRequest.ProtoReflect.Descriptor instead.
+func (*UpdateSavedQueryRequest) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{7}
+}
+
+func (x *UpdateSavedQueryRequest) GetSavedQuery() *SavedQuery {
+ if x != nil {
+ return x.SavedQuery
+ }
+ return nil
+}
+
+func (x *UpdateSavedQueryRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
+ if x != nil {
+ return x.UpdateMask
+ }
+ return nil
+}
+
+type BatchUpdateSavedQueryOrganizerRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The parent resource whose saved queries' organizers are updated.
+ // Format: projects/{project}
+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
+ // To filter the batch update target.
+ // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ //
+ // Supported filter:
+ // - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ // - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ // - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ // - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ // - folder: the saved query organizer folder path, support exact "==" operator.
+ Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
+ // The organizer fields to update.
+ Organizer *SavedQueryOrganizer `protobuf:"bytes,3,opt,name=organizer,proto3" json:"organizer,omitempty"`
+ // The list of fields to be updated.
+ // Fields are specified relative to the saved query organizer.
+ // Only support update the following fields for now:
+ // - `starred`
+ // - `folders`
+ UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *BatchUpdateSavedQueryOrganizerRequest) Reset() {
+ *x = BatchUpdateSavedQueryOrganizerRequest{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[8]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *BatchUpdateSavedQueryOrganizerRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*BatchUpdateSavedQueryOrganizerRequest) ProtoMessage() {}
+
+func (x *BatchUpdateSavedQueryOrganizerRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[8]
+ 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 BatchUpdateSavedQueryOrganizerRequest.ProtoReflect.Descriptor instead.
+func (*BatchUpdateSavedQueryOrganizerRequest) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{8}
+}
+
+func (x *BatchUpdateSavedQueryOrganizerRequest) GetParent() string {
+ if x != nil {
+ return x.Parent
+ }
+ return ""
+}
+
+func (x *BatchUpdateSavedQueryOrganizerRequest) GetFilter() string {
+ if x != nil {
+ return x.Filter
+ }
+ return ""
+}
+
+func (x *BatchUpdateSavedQueryOrganizerRequest) GetOrganizer() *SavedQueryOrganizer {
+ if x != nil {
+ return x.Organizer
+ }
+ return nil
+}
+
+func (x *BatchUpdateSavedQueryOrganizerRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
+ if x != nil {
+ return x.UpdateMask
+ }
+ return nil
+}
+
+type BatchUpdateSavedQueryOrganizerResponse struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ SavedQueryOrganizers []*SavedQueryOrganizer `protobuf:"bytes,1,rep,name=saved_query_organizers,json=savedQueryOrganizers,proto3" json:"saved_query_organizers,omitempty"`
+ UpdatedCount int32 `protobuf:"varint,2,opt,name=updated_count,json=updatedCount,proto3" json:"updated_count,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *BatchUpdateSavedQueryOrganizerResponse) Reset() {
+ *x = BatchUpdateSavedQueryOrganizerResponse{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[9]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *BatchUpdateSavedQueryOrganizerResponse) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*BatchUpdateSavedQueryOrganizerResponse) ProtoMessage() {}
+
+func (x *BatchUpdateSavedQueryOrganizerResponse) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[9]
+ 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 BatchUpdateSavedQueryOrganizerResponse.ProtoReflect.Descriptor instead.
+func (*BatchUpdateSavedQueryOrganizerResponse) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{9}
+}
+
+func (x *BatchUpdateSavedQueryOrganizerResponse) GetSavedQueryOrganizers() []*SavedQueryOrganizer {
+ if x != nil {
+ return x.SavedQueryOrganizers
+ }
+ return nil
+}
+
+func (x *BatchUpdateSavedQueryOrganizerResponse) GetUpdatedCount() int32 {
+ if x != nil {
+ return x.UpdatedCount
+ }
+ return 0
+}
+
+type UpdateSavedQueryOrganizerRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The organizer to update.
+ //
+ // The organizer's `saved_query` field is used to identify the saved query.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ Organizer *SavedQueryOrganizer `protobuf:"bytes,1,opt,name=organizer,proto3" json:"organizer,omitempty"`
+ // The list of fields to be updated.
+ // Fields are specified relative to the saved query organizer.
+ // Only support update the following fields for now:
+ // - `starred`
+ UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
+ // If set to true, and the saved query organizer is not found, a new saved query organizer will be created.
+ // In this situation, `update_mask` is ignored.
+ AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *UpdateSavedQueryOrganizerRequest) Reset() {
+ *x = UpdateSavedQueryOrganizerRequest{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[10]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *UpdateSavedQueryOrganizerRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*UpdateSavedQueryOrganizerRequest) ProtoMessage() {}
+
+func (x *UpdateSavedQueryOrganizerRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[10]
+ 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 UpdateSavedQueryOrganizerRequest.ProtoReflect.Descriptor instead.
+func (*UpdateSavedQueryOrganizerRequest) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{10}
+}
+
+func (x *UpdateSavedQueryOrganizerRequest) GetOrganizer() *SavedQueryOrganizer {
+ if x != nil {
+ return x.Organizer
+ }
+ return nil
+}
+
+func (x *UpdateSavedQueryOrganizerRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
+ if x != nil {
+ return x.UpdateMask
+ }
+ return nil
+}
+
+func (x *UpdateSavedQueryOrganizerRequest) GetAllowMissing() bool {
+ if x != nil {
+ return x.AllowMissing
+ }
+ return false
+}
+
+type SavedQueryOrganizer struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The name of the saved query.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ SavedQuery string `protobuf:"bytes,1,opt,name=saved_query,json=savedQuery,proto3" json:"saved_query,omitempty"`
+ // starred means if the saved query is starred.
+ 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
+}
+
+func (x *SavedQueryOrganizer) Reset() {
+ *x = SavedQueryOrganizer{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[11]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SavedQueryOrganizer) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SavedQueryOrganizer) ProtoMessage() {}
+
+func (x *SavedQueryOrganizer) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[11]
+ 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 SavedQueryOrganizer.ProtoReflect.Descriptor instead.
+func (*SavedQueryOrganizer) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{11}
+}
+
+func (x *SavedQueryOrganizer) GetSavedQuery() string {
+ if x != nil {
+ return x.SavedQuery
+ }
+ return ""
+}
+
+func (x *SavedQueryOrganizer) GetStarred() bool {
+ if x != nil {
+ return x.Starred
+ }
+ return false
+}
+
+func (x *SavedQueryOrganizer) GetFolders() []string {
+ if x != nil {
+ return x.Folders
+ }
+ return nil
+}
+
+type DeleteSavedQueryRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The name of the saved query to delete.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *DeleteSavedQueryRequest) Reset() {
+ *x = DeleteSavedQueryRequest{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[12]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *DeleteSavedQueryRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*DeleteSavedQueryRequest) ProtoMessage() {}
+
+func (x *DeleteSavedQueryRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[12]
+ 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 DeleteSavedQueryRequest.ProtoReflect.Descriptor instead.
+func (*DeleteSavedQueryRequest) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{12}
+}
+
+func (x *DeleteSavedQueryRequest) GetName() string {
+ if x != nil {
+ return x.Name
+ }
+ return ""
+}
+
+type SearchSavedQueriesRequest struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The parent resource of the saved queries.
+ // Format: projects/{project}
+ Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
+ // To filter the search result.
+ // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ //
+ // Supported filter:
+ // - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ // - title: the saved query title, support "contains" operator.
+ // - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ // - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ // - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ // - folder: the saved query organizer folder path, support "==" operator.
+ //
+ // For example:
+ // creator == "users/{email}"
+ // title.contains("saved query title")
+ // creator != "users/{email}"
+ // starred == true
+ // starred == false
+ // visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
+ // visibility == "PRIVATE"
+ // folder == "foo/bar"
+ Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
+ // The maximum number of saved queries to return. The service may return fewer than
+ // this value.
+ // If unspecified, at most 10 saved queries will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
+ // A page token, received from a previous `SearchSavedQueries` call.
+ // Provide this to retrieve the subsequent page.
+ PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SearchSavedQueriesRequest) Reset() {
+ *x = SearchSavedQueriesRequest{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[13]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SearchSavedQueriesRequest) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SearchSavedQueriesRequest) ProtoMessage() {}
+
+func (x *SearchSavedQueriesRequest) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[13]
+ 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 SearchSavedQueriesRequest.ProtoReflect.Descriptor instead.
+func (*SearchSavedQueriesRequest) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{13}
+}
+
+func (x *SearchSavedQueriesRequest) GetParent() string {
+ if x != nil {
+ return x.Parent
+ }
+ return ""
+}
+
+func (x *SearchSavedQueriesRequest) GetFilter() string {
+ if x != nil {
+ return x.Filter
+ }
+ return ""
+}
+
+func (x *SearchSavedQueriesRequest) GetPageSize() int32 {
+ if x != nil {
+ return x.PageSize
+ }
+ return 0
+}
+
+func (x *SearchSavedQueriesRequest) GetPageToken() string {
+ if x != nil {
+ return x.PageToken
+ }
+ return ""
+}
+
+type SearchSavedQueriesResponse struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The saved queries that matched the search criteria.
+ SavedQueries []*SavedQuery `protobuf:"bytes,1,rep,name=saved_queries,json=savedQueries,proto3" json:"saved_queries,omitempty"`
+ // A token to retrieve next page of saved queries.
+ // Pass this value in the page_token field in the subsequent call to
+ // `SearchSavedQueries` method to retrieve the next page of saved queries.
+ NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
+ unknownFields protoimpl.UnknownFields
+ sizeCache protoimpl.SizeCache
+}
+
+func (x *SearchSavedQueriesResponse) Reset() {
+ *x = SearchSavedQueriesResponse{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[14]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SearchSavedQueriesResponse) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SearchSavedQueriesResponse) ProtoMessage() {}
+
+func (x *SearchSavedQueriesResponse) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[14]
+ 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 SearchSavedQueriesResponse.ProtoReflect.Descriptor instead.
+func (*SearchSavedQueriesResponse) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{14}
+}
+
+func (x *SearchSavedQueriesResponse) GetSavedQueries() []*SavedQuery {
+ if x != nil {
+ return x.SavedQueries
+ }
+ return nil
+}
+
+func (x *SearchSavedQueriesResponse) GetNextPageToken() string {
+ if x != nil {
+ return x.NextPageToken
+ }
+ return ""
+}
+
+type SavedQuery struct {
+ state protoimpl.MessageState `protogen:"open.v1"`
+ // The name of the saved query resource, generated by the server.
+ // Canonical parent is project.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
+ // The project resource name.
+ // Format: projects/{project}
+ Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
+ // The database resource name.
+ // Format: instances/{instance}/databases/{database}
+ // If the database parent doesn't exist, the database field is empty.
+ Database string `protobuf:"bytes,3,opt,name=database,proto3" json:"database,omitempty"`
+ // The title of the saved query.
+ Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`
+ // The creator of the SavedQuery.
+ // Format: users/{email}
+ Creator string `protobuf:"bytes,5,opt,name=creator,proto3" json:"creator,omitempty"`
+ // The create time of the saved query.
+ CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
+ // The last update time of the saved query.
+ UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
+ // The content of the saved query.
+ // By default, it will be cut off in SearchSavedQueries() method. If it doesn't match the `content_size`, you can
+ // use GetSavedQuery() request to retrieve the full content.
+ Content []byte `protobuf:"bytes,8,opt,name=content,proto3" json:"content,omitempty"`
+ // content_size is the full size of the content, may not match the size of the `content` field.
+ ContentSize int64 `protobuf:"varint,9,opt,name=content_size,json=contentSize,proto3" json:"content_size,omitempty"`
+ Visibility SavedQuery_Visibility `protobuf:"varint,10,opt,name=visibility,proto3,enum=bytebase.v1.SavedQuery_Visibility" json:"visibility,omitempty"`
+ // starred indicates whether the saved query is starred by the current authenticated user.
+ 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
+}
+
+func (x *SavedQuery) Reset() {
+ *x = SavedQuery{}
+ mi := &file_v1_saved_query_service_proto_msgTypes[15]
+ ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
+ ms.StoreMessageInfo(mi)
+}
+
+func (x *SavedQuery) String() string {
+ return protoimpl.X.MessageStringOf(x)
+}
+
+func (*SavedQuery) ProtoMessage() {}
+
+func (x *SavedQuery) ProtoReflect() protoreflect.Message {
+ mi := &file_v1_saved_query_service_proto_msgTypes[15]
+ 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 SavedQuery.ProtoReflect.Descriptor instead.
+func (*SavedQuery) Descriptor() ([]byte, []int) {
+ return file_v1_saved_query_service_proto_rawDescGZIP(), []int{15}
+}
+
+func (x *SavedQuery) GetName() string {
+ if x != nil {
+ return x.Name
+ }
+ return ""
+}
+
+func (x *SavedQuery) GetProject() string {
+ if x != nil {
+ return x.Project
+ }
+ return ""
+}
+
+func (x *SavedQuery) GetDatabase() string {
+ if x != nil {
+ return x.Database
+ }
+ return ""
+}
+
+func (x *SavedQuery) GetTitle() string {
+ if x != nil {
+ return x.Title
+ }
+ return ""
+}
+
+func (x *SavedQuery) GetCreator() string {
+ if x != nil {
+ return x.Creator
+ }
+ return ""
+}
+
+func (x *SavedQuery) GetCreateTime() *timestamppb.Timestamp {
+ if x != nil {
+ return x.CreateTime
+ }
+ return nil
+}
+
+func (x *SavedQuery) GetUpdateTime() *timestamppb.Timestamp {
+ if x != nil {
+ return x.UpdateTime
+ }
+ return nil
+}
+
+func (x *SavedQuery) GetContent() []byte {
+ if x != nil {
+ return x.Content
+ }
+ return nil
+}
+
+func (x *SavedQuery) GetContentSize() int64 {
+ if x != nil {
+ return x.ContentSize
+ }
+ return 0
+}
+
+func (x *SavedQuery) GetVisibility() SavedQuery_Visibility {
+ if x != nil {
+ return x.Visibility
+ }
+ return SavedQuery_VISIBILITY_UNSPECIFIED
+}
+
+func (x *SavedQuery) GetStarred() bool {
+ if x != nil {
+ return x.Starred
+ }
+ return false
+}
+
+func (x *SavedQuery) GetFolders() []string {
+ if x != nil {
+ return x.Folders
+ }
+ return nil
+}
+
+var File_v1_saved_query_service_proto protoreflect.FileDescriptor
+
+const file_v1_saved_query_service_proto_rawDesc = "" +
+ "\n" +
+ "\x1cv1/saved_query_service.proto\x12\vbytebase.v1\x1a\x1bbuf/validate/validate.proto\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x13v1/annotation.proto\"u\n" +
+ "\x17CreateSavedQueryRequest\x12\x1b\n" +
+ "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\x06parent\x12=\n" +
+ "\vsaved_query\x18\x02 \x01(\v2\x17.bytebase.v1.SavedQueryB\x03\xe0A\x02R\n" +
+ "savedQuery\"/\n" +
+ "\x14GetSavedQueryRequest\x12\x17\n" +
+ "\x04name\x18\x01 \x01(\tB\x03\xe0A\x02R\x04name\"\xa3\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" +
+ "\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" +
+ "\x1cListSavedQueryFoldersRequest\x12\x1b\n" +
+ "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\x06parent\"X\n" +
+ "\x1dListSavedQueryFoldersResponse\x127\n" +
+ "\afolders\x18\x01 \x03(\v2\x1d.bytebase.v1.SavedQueryFolderR\afolders\"\xac\x01\n" +
+ "\x10SavedQueryFolder\x12\x18\n" +
+ "\afolders\x18\x01 \x03(\tR\afolders\x12B\n" +
+ "\bcategory\x18\x02 \x01(\x0e2&.bytebase.v1.SavedQueryFolder.CategoryR\bcategory\":\n" +
+ "\bCategory\x12\x18\n" +
+ "\x14CATEGORY_UNSPECIFIED\x10\x00\x12\b\n" +
+ "\x04MINE\x10\x01\x12\n" +
+ "\n" +
+ "\x06SHARED\x10\x02\"\x95\x01\n" +
+ "\x17UpdateSavedQueryRequest\x12=\n" +
+ "\vsaved_query\x18\x01 \x01(\v2\x17.bytebase.v1.SavedQueryB\x03\xe0A\x02R\n" +
+ "savedQuery\x12;\n" +
+ "\vupdate_mask\x18\x02 \x01(\v2\x1a.google.protobuf.FieldMaskR\n" +
+ "updateMask\"\xe3\x01\n" +
+ "%BatchUpdateSavedQueryOrganizerRequest\x12\x1b\n" +
+ "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\x06parent\x12\x16\n" +
+ "\x06filter\x18\x02 \x01(\tR\x06filter\x12C\n" +
+ "\torganizer\x18\x03 \x01(\v2 .bytebase.v1.SavedQueryOrganizerB\x03\xe0A\x02R\torganizer\x12@\n" +
+ "\vupdate_mask\x18\x04 \x01(\v2\x1a.google.protobuf.FieldMaskB\x03\xe0A\x02R\n" +
+ "updateMask\"\xa5\x01\n" +
+ "&BatchUpdateSavedQueryOrganizerResponse\x12V\n" +
+ "\x16saved_query_organizers\x18\x01 \x03(\v2 .bytebase.v1.SavedQueryOrganizerR\x14savedQueryOrganizers\x12#\n" +
+ "\rupdated_count\x18\x02 \x01(\x05R\fupdatedCount\"\xc9\x01\n" +
+ " UpdateSavedQueryOrganizerRequest\x12C\n" +
+ "\torganizer\x18\x01 \x01(\v2 .bytebase.v1.SavedQueryOrganizerB\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\"o\n" +
+ "\x13SavedQueryOrganizer\x12$\n" +
+ "\vsaved_query\x18\x01 \x01(\tB\x03\xe0A\x02R\n" +
+ "savedQuery\x12\x18\n" +
+ "\astarred\x18\x02 \x01(\bR\astarred\x12\x18\n" +
+ "\afolders\x18\x03 \x03(\tR\afolders\"2\n" +
+ "\x17DeleteSavedQueryRequest\x12\x17\n" +
+ "\x04name\x18\x01 \x01(\tB\x03\xe0A\x02R\x04name\"\x8c\x01\n" +
+ "\x19SearchSavedQueriesRequest\x12\x1b\n" +
+ "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\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\"\x82\x01\n" +
+ "\x1aSearchSavedQueriesResponse\x12<\n" +
+ "\rsaved_queries\x18\x01 \x03(\v2\x17.bytebase.v1.SavedQueryR\fsavedQueries\x12&\n" +
+ "\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken\"\xd3\x04\n" +
+ "\n" +
+ "SavedQuery\x12\x1a\n" +
+ "\x04name\x18\x01 \x01(\tB\x06\xe0A\x02\xe0A\x05R\x04name\x12\x1d\n" +
+ "\aproject\x18\x02 \x01(\tB\x03\xe0A\x03R\aproject\x12\x1a\n" +
+ "\bdatabase\x18\x03 \x01(\tR\bdatabase\x12!\n" +
+ "\x05title\x18\x04 \x01(\tB\v\xe0A\x02\xbaH\x05r\x03\x18\xc8\x01R\x05title\x12\x1d\n" +
+ "\acreator\x18\x05 \x01(\tB\x03\xe0A\x03R\acreator\x12@\n" +
+ "\vcreate_time\x18\x06 \x01(\v2\x1a.google.protobuf.TimestampB\x03\xe0A\x03R\n" +
+ "createTime\x12@\n" +
+ "\vupdate_time\x18\a \x01(\v2\x1a.google.protobuf.TimestampB\x03\xe0A\x03R\n" +
+ "updateTime\x12\x1d\n" +
+ "\acontent\x18\b \x01(\fB\x03\xe0A\x02R\acontent\x12&\n" +
+ "\fcontent_size\x18\t \x01(\x03B\x03\xe0A\x03R\vcontentSize\x12G\n" +
+ "\n" +
+ "visibility\x18\n" +
+ " \x01(\x0e2\".bytebase.v1.SavedQuery.VisibilityB\x03\xe0A\x02R\n" +
+ "visibility\x12\x1d\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" +
+ "\fPROJECT_READ\x10\x01\x12\x11\n" +
+ "\rPROJECT_WRITE\x10\x02\x12\v\n" +
+ "\aPRIVATE\x10\x032\xee\f\n" +
+ "\x11SavedQueryService\x12\xa5\x01\n" +
+ "\x10CreateSavedQuery\x12$.bytebase.v1.CreateSavedQueryRequest\x1a\x17.bytebase.v1.SavedQuery\"R\xdaA\x12parent,saved_query\x90\xea0\x02\x82\xd3\xe4\x93\x023:\vsaved_query\"$/v1/{parent=projects/*}/savedQueries\x12\x84\x01\n" +
+ "\rGetSavedQuery\x12!.bytebase.v1.GetSavedQueryRequest\x1a\x17.bytebase.v1.SavedQuery\"7\xdaA\x04name\x90\xea0\x02\x82\xd3\xe4\x93\x02&\x12$/v1/{name=projects/*/savedQueries/*}\x12\xb0\x01\n" +
+ "\x10ListSavedQueries\x12$.bytebase.v1.ListSavedQueriesRequest\x1a%.bytebase.v1.ListSavedQueriesResponse\"O\xdaA\x06parent\x8a\xea0\x12bb.worksheets.list\x90\xea0\x01\x82\xd3\xe4\x93\x02&\x12$/v1/{parent=projects/*}/savedQueries\x12\xae\x01\n" +
+ "\x15ListSavedQueryFolders\x12).bytebase.v1.ListSavedQueryFoldersRequest\x1a*.bytebase.v1.ListSavedQueryFoldersResponse\">\xdaA\x06parent\x90\xea0\x02\x82\xd3\xe4\x93\x02+\x12)/v1/{parent=projects/*}/savedQueryFolders\x12\xaa\x01\n" +
+ "\x12SearchSavedQueries\x12&.bytebase.v1.SearchSavedQueriesRequest\x1a'.bytebase.v1.SearchSavedQueriesResponse\"C\xdaA\x06parent\x90\xea0\x02\x82\xd3\xe4\x93\x020:\x01*\"+/v1/{parent=projects/*}/savedQueries:search\x12\xb6\x01\n" +
+ "\x10UpdateSavedQuery\x12$.bytebase.v1.UpdateSavedQueryRequest\x1a\x17.bytebase.v1.SavedQuery\"c\xdaA\x17saved_query,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x02?:\vsaved_query20/v1/{saved_query.name=projects/*/savedQueries/*}\x12\xdc\x01\n" +
+ "\x19UpdateSavedQueryOrganizer\x12-.bytebase.v1.UpdateSavedQueryOrganizerRequest\x1a .bytebase.v1.SavedQueryOrganizer\"n\xdaA\x15organizer,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x02L:\torganizer2?/v1/{organizer.saved_query=projects/*/savedQueries/*}/organizer\x12\xf4\x01\n" +
+ "\x1eBatchUpdateSavedQueryOrganizer\x122.bytebase.v1.BatchUpdateSavedQueryOrganizerRequest\x1a3.bytebase.v1.BatchUpdateSavedQueryOrganizerResponse\"i\xdaA\x1cparent,organizer,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x02@:\x01*\";/v1/{parent=projects/*}/savedQueries/organizers:batchUpdate\x12\x89\x01\n" +
+ "\x10DeleteSavedQuery\x12$.bytebase.v1.DeleteSavedQueryRequest\x1a\x16.google.protobuf.Empty\"7\xdaA\x04name\x90\xea0\x02\x82\xd3\xe4\x93\x02&*$/v1/{name=projects/*/savedQueries/*}B\xac\x01\n" +
+ "\x0fcom.bytebase.v1B\x16SavedQueryServiceProtoP\x01Z4github.com/bytebase/bytebase/backend/generated-go/v1\xa2\x02\x03BXX\xaa\x02\vBytebase.V1\xca\x02\vBytebase\\V1\xe2\x02\x17Bytebase\\V1\\GPBMetadata\xea\x02\fBytebase::V1b\x06proto3"
+
+var (
+ file_v1_saved_query_service_proto_rawDescOnce sync.Once
+ file_v1_saved_query_service_proto_rawDescData []byte
+)
+
+func file_v1_saved_query_service_proto_rawDescGZIP() []byte {
+ file_v1_saved_query_service_proto_rawDescOnce.Do(func() {
+ file_v1_saved_query_service_proto_rawDescData = protoimpl.X.CompressGZIP(unsafe.Slice(unsafe.StringData(file_v1_saved_query_service_proto_rawDesc), len(file_v1_saved_query_service_proto_rawDesc)))
+ })
+ return file_v1_saved_query_service_proto_rawDescData
+}
+
+var file_v1_saved_query_service_proto_enumTypes = make([]protoimpl.EnumInfo, 2)
+var file_v1_saved_query_service_proto_msgTypes = make([]protoimpl.MessageInfo, 16)
+var file_v1_saved_query_service_proto_goTypes = []any{
+ (SavedQueryFolder_Category)(0), // 0: bytebase.v1.SavedQueryFolder.Category
+ (SavedQuery_Visibility)(0), // 1: bytebase.v1.SavedQuery.Visibility
+ (*CreateSavedQueryRequest)(nil), // 2: bytebase.v1.CreateSavedQueryRequest
+ (*GetSavedQueryRequest)(nil), // 3: bytebase.v1.GetSavedQueryRequest
+ (*ListSavedQueriesRequest)(nil), // 4: bytebase.v1.ListSavedQueriesRequest
+ (*ListSavedQueriesResponse)(nil), // 5: bytebase.v1.ListSavedQueriesResponse
+ (*ListSavedQueryFoldersRequest)(nil), // 6: bytebase.v1.ListSavedQueryFoldersRequest
+ (*ListSavedQueryFoldersResponse)(nil), // 7: bytebase.v1.ListSavedQueryFoldersResponse
+ (*SavedQueryFolder)(nil), // 8: bytebase.v1.SavedQueryFolder
+ (*UpdateSavedQueryRequest)(nil), // 9: bytebase.v1.UpdateSavedQueryRequest
+ (*BatchUpdateSavedQueryOrganizerRequest)(nil), // 10: bytebase.v1.BatchUpdateSavedQueryOrganizerRequest
+ (*BatchUpdateSavedQueryOrganizerResponse)(nil), // 11: bytebase.v1.BatchUpdateSavedQueryOrganizerResponse
+ (*UpdateSavedQueryOrganizerRequest)(nil), // 12: bytebase.v1.UpdateSavedQueryOrganizerRequest
+ (*SavedQueryOrganizer)(nil), // 13: bytebase.v1.SavedQueryOrganizer
+ (*DeleteSavedQueryRequest)(nil), // 14: bytebase.v1.DeleteSavedQueryRequest
+ (*SearchSavedQueriesRequest)(nil), // 15: bytebase.v1.SearchSavedQueriesRequest
+ (*SearchSavedQueriesResponse)(nil), // 16: bytebase.v1.SearchSavedQueriesResponse
+ (*SavedQuery)(nil), // 17: bytebase.v1.SavedQuery
+ (*fieldmaskpb.FieldMask)(nil), // 18: google.protobuf.FieldMask
+ (*timestamppb.Timestamp)(nil), // 19: google.protobuf.Timestamp
+ (*emptypb.Empty)(nil), // 20: google.protobuf.Empty
+}
+var file_v1_saved_query_service_proto_depIdxs = []int32{
+ 17, // 0: bytebase.v1.CreateSavedQueryRequest.saved_query:type_name -> bytebase.v1.SavedQuery
+ 17, // 1: bytebase.v1.ListSavedQueriesResponse.saved_queries:type_name -> bytebase.v1.SavedQuery
+ 8, // 2: bytebase.v1.ListSavedQueryFoldersResponse.folders:type_name -> bytebase.v1.SavedQueryFolder
+ 0, // 3: bytebase.v1.SavedQueryFolder.category:type_name -> bytebase.v1.SavedQueryFolder.Category
+ 17, // 4: bytebase.v1.UpdateSavedQueryRequest.saved_query:type_name -> bytebase.v1.SavedQuery
+ 18, // 5: bytebase.v1.UpdateSavedQueryRequest.update_mask:type_name -> google.protobuf.FieldMask
+ 13, // 6: bytebase.v1.BatchUpdateSavedQueryOrganizerRequest.organizer:type_name -> bytebase.v1.SavedQueryOrganizer
+ 18, // 7: bytebase.v1.BatchUpdateSavedQueryOrganizerRequest.update_mask:type_name -> google.protobuf.FieldMask
+ 13, // 8: bytebase.v1.BatchUpdateSavedQueryOrganizerResponse.saved_query_organizers:type_name -> bytebase.v1.SavedQueryOrganizer
+ 13, // 9: bytebase.v1.UpdateSavedQueryOrganizerRequest.organizer:type_name -> bytebase.v1.SavedQueryOrganizer
+ 18, // 10: bytebase.v1.UpdateSavedQueryOrganizerRequest.update_mask:type_name -> google.protobuf.FieldMask
+ 17, // 11: bytebase.v1.SearchSavedQueriesResponse.saved_queries:type_name -> bytebase.v1.SavedQuery
+ 19, // 12: bytebase.v1.SavedQuery.create_time:type_name -> google.protobuf.Timestamp
+ 19, // 13: bytebase.v1.SavedQuery.update_time:type_name -> google.protobuf.Timestamp
+ 1, // 14: bytebase.v1.SavedQuery.visibility:type_name -> bytebase.v1.SavedQuery.Visibility
+ 2, // 15: bytebase.v1.SavedQueryService.CreateSavedQuery:input_type -> bytebase.v1.CreateSavedQueryRequest
+ 3, // 16: bytebase.v1.SavedQueryService.GetSavedQuery:input_type -> bytebase.v1.GetSavedQueryRequest
+ 4, // 17: bytebase.v1.SavedQueryService.ListSavedQueries:input_type -> bytebase.v1.ListSavedQueriesRequest
+ 6, // 18: bytebase.v1.SavedQueryService.ListSavedQueryFolders:input_type -> bytebase.v1.ListSavedQueryFoldersRequest
+ 15, // 19: bytebase.v1.SavedQueryService.SearchSavedQueries:input_type -> bytebase.v1.SearchSavedQueriesRequest
+ 9, // 20: bytebase.v1.SavedQueryService.UpdateSavedQuery:input_type -> bytebase.v1.UpdateSavedQueryRequest
+ 12, // 21: bytebase.v1.SavedQueryService.UpdateSavedQueryOrganizer:input_type -> bytebase.v1.UpdateSavedQueryOrganizerRequest
+ 10, // 22: bytebase.v1.SavedQueryService.BatchUpdateSavedQueryOrganizer:input_type -> bytebase.v1.BatchUpdateSavedQueryOrganizerRequest
+ 14, // 23: bytebase.v1.SavedQueryService.DeleteSavedQuery:input_type -> bytebase.v1.DeleteSavedQueryRequest
+ 17, // 24: bytebase.v1.SavedQueryService.CreateSavedQuery:output_type -> bytebase.v1.SavedQuery
+ 17, // 25: bytebase.v1.SavedQueryService.GetSavedQuery:output_type -> bytebase.v1.SavedQuery
+ 5, // 26: bytebase.v1.SavedQueryService.ListSavedQueries:output_type -> bytebase.v1.ListSavedQueriesResponse
+ 7, // 27: bytebase.v1.SavedQueryService.ListSavedQueryFolders:output_type -> bytebase.v1.ListSavedQueryFoldersResponse
+ 16, // 28: bytebase.v1.SavedQueryService.SearchSavedQueries:output_type -> bytebase.v1.SearchSavedQueriesResponse
+ 17, // 29: bytebase.v1.SavedQueryService.UpdateSavedQuery:output_type -> bytebase.v1.SavedQuery
+ 13, // 30: bytebase.v1.SavedQueryService.UpdateSavedQueryOrganizer:output_type -> bytebase.v1.SavedQueryOrganizer
+ 11, // 31: bytebase.v1.SavedQueryService.BatchUpdateSavedQueryOrganizer:output_type -> bytebase.v1.BatchUpdateSavedQueryOrganizerResponse
+ 20, // 32: bytebase.v1.SavedQueryService.DeleteSavedQuery:output_type -> google.protobuf.Empty
+ 24, // [24:33] is the sub-list for method output_type
+ 15, // [15:24] is the sub-list for method input_type
+ 15, // [15:15] is the sub-list for extension type_name
+ 15, // [15:15] is the sub-list for extension extendee
+ 0, // [0:15] is the sub-list for field type_name
+}
+
+func init() { file_v1_saved_query_service_proto_init() }
+func file_v1_saved_query_service_proto_init() {
+ if File_v1_saved_query_service_proto != nil {
+ return
+ }
+ file_v1_annotation_proto_init()
+ type x struct{}
+ out := protoimpl.TypeBuilder{
+ File: protoimpl.DescBuilder{
+ GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
+ RawDescriptor: unsafe.Slice(unsafe.StringData(file_v1_saved_query_service_proto_rawDesc), len(file_v1_saved_query_service_proto_rawDesc)),
+ NumEnums: 2,
+ NumMessages: 16,
+ NumExtensions: 0,
+ NumServices: 1,
+ },
+ GoTypes: file_v1_saved_query_service_proto_goTypes,
+ DependencyIndexes: file_v1_saved_query_service_proto_depIdxs,
+ EnumInfos: file_v1_saved_query_service_proto_enumTypes,
+ MessageInfos: file_v1_saved_query_service_proto_msgTypes,
+ }.Build()
+ File_v1_saved_query_service_proto = out.File
+ file_v1_saved_query_service_proto_goTypes = nil
+ file_v1_saved_query_service_proto_depIdxs = nil
+}
diff --git a/backend/generated-go/v1/worksheet_service.pb.gw.go b/backend/generated-go/v1/saved_query_service.pb.gw.go
similarity index 53%
rename from backend/generated-go/v1/worksheet_service.pb.gw.go
rename to backend/generated-go/v1/saved_query_service.pb.gw.go
index ae9a0dc597..71437a5178 100644
--- a/backend/generated-go/v1/worksheet_service.pb.gw.go
+++ b/backend/generated-go/v1/saved_query_service.pb.gw.go
@@ -1,5 +1,5 @@
// Code generated by protoc-gen-grpc-gateway. DO NOT EDIT.
-// source: v1/worksheet_service.proto
+// source: v1/saved_query_service.proto
/*
Package v1 is a reverse proxy.
@@ -35,13 +35,13 @@ var (
_ = metadata.Join
)
-func request_WorksheetService_CreateWorksheet_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func request_SavedQueryService_CreateSavedQuery_0(ctx context.Context, marshaler runtime.Marshaler, client SavedQueryServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq CreateWorksheetRequest
+ protoReq CreateSavedQueryRequest
metadata runtime.ServerMetadata
err error
)
- if err := marshaler.NewDecoder(req.Body).Decode(&protoReq.Worksheet); err != nil && !errors.Is(err, io.EOF) {
+ if err := marshaler.NewDecoder(req.Body).Decode(&protoReq.SavedQuery); err != nil && !errors.Is(err, io.EOF) {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
val, ok := pathParams["parent"]
@@ -55,17 +55,17 @@ func request_WorksheetService_CreateWorksheet_0(ctx context.Context, marshaler r
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
- msg, err := client.CreateWorksheet(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ msg, err := client.CreateSavedQuery(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
-func local_request_WorksheetService_CreateWorksheet_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func local_request_SavedQueryService_CreateSavedQuery_0(ctx context.Context, marshaler runtime.Marshaler, server SavedQueryServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq CreateWorksheetRequest
+ protoReq CreateSavedQueryRequest
metadata runtime.ServerMetadata
err error
)
- if err := marshaler.NewDecoder(req.Body).Decode(&protoReq.Worksheet); err != nil && !errors.Is(err, io.EOF) {
+ if err := marshaler.NewDecoder(req.Body).Decode(&protoReq.SavedQuery); err != nil && !errors.Is(err, io.EOF) {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
val, ok := pathParams["parent"]
@@ -76,13 +76,13 @@ func local_request_WorksheetService_CreateWorksheet_0(ctx context.Context, marsh
if err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "parent", err)
}
- msg, err := server.CreateWorksheet(ctx, &protoReq)
+ msg, err := server.CreateSavedQuery(ctx, &protoReq)
return msg, metadata, err
}
-func request_WorksheetService_GetWorksheet_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func request_SavedQueryService_GetSavedQuery_0(ctx context.Context, marshaler runtime.Marshaler, client SavedQueryServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq GetWorksheetRequest
+ protoReq GetSavedQueryRequest
metadata runtime.ServerMetadata
err error
)
@@ -97,13 +97,13 @@ func request_WorksheetService_GetWorksheet_0(ctx context.Context, marshaler runt
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
- msg, err := client.GetWorksheet(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ msg, err := client.GetSavedQuery(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
-func local_request_WorksheetService_GetWorksheet_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func local_request_SavedQueryService_GetSavedQuery_0(ctx context.Context, marshaler runtime.Marshaler, server SavedQueryServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq GetWorksheetRequest
+ protoReq GetSavedQueryRequest
metadata runtime.ServerMetadata
err error
)
@@ -115,15 +115,15 @@ func local_request_WorksheetService_GetWorksheet_0(ctx context.Context, marshale
if err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "name", err)
}
- msg, err := server.GetWorksheet(ctx, &protoReq)
+ msg, err := server.GetSavedQuery(ctx, &protoReq)
return msg, metadata, err
}
-var filter_WorksheetService_ListWorksheets_0 = &utilities.DoubleArray{Encoding: map[string]int{"parent": 0}, Base: []int{1, 1, 0}, Check: []int{0, 1, 2}}
+var filter_SavedQueryService_ListSavedQueries_0 = &utilities.DoubleArray{Encoding: map[string]int{"parent": 0}, Base: []int{1, 1, 0}, Check: []int{0, 1, 2}}
-func request_WorksheetService_ListWorksheets_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func request_SavedQueryService_ListSavedQueries_0(ctx context.Context, marshaler runtime.Marshaler, client SavedQueryServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq ListWorksheetsRequest
+ protoReq ListSavedQueriesRequest
metadata runtime.ServerMetadata
err error
)
@@ -138,19 +138,19 @@ func request_WorksheetService_ListWorksheets_0(ctx context.Context, marshaler ru
if err := req.ParseForm(); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
- if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_WorksheetService_ListWorksheets_0); err != nil {
+ if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_SavedQueryService_ListSavedQueries_0); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
- msg, err := client.ListWorksheets(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ msg, err := client.ListSavedQueries(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
-func local_request_WorksheetService_ListWorksheets_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func local_request_SavedQueryService_ListSavedQueries_0(ctx context.Context, marshaler runtime.Marshaler, server SavedQueryServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq ListWorksheetsRequest
+ protoReq ListSavedQueriesRequest
metadata runtime.ServerMetadata
err error
)
@@ -165,16 +165,16 @@ func local_request_WorksheetService_ListWorksheets_0(ctx context.Context, marsha
if err := req.ParseForm(); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
- if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_WorksheetService_ListWorksheets_0); err != nil {
+ if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_SavedQueryService_ListSavedQueries_0); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
- msg, err := server.ListWorksheets(ctx, &protoReq)
+ msg, err := server.ListSavedQueries(ctx, &protoReq)
return msg, metadata, err
}
-func request_WorksheetService_ListWorksheetFolders_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func request_SavedQueryService_ListSavedQueryFolders_0(ctx context.Context, marshaler runtime.Marshaler, client SavedQueryServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq ListWorksheetFoldersRequest
+ protoReq ListSavedQueryFoldersRequest
metadata runtime.ServerMetadata
err error
)
@@ -189,13 +189,13 @@ func request_WorksheetService_ListWorksheetFolders_0(ctx context.Context, marsha
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
- msg, err := client.ListWorksheetFolders(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ msg, err := client.ListSavedQueryFolders(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
-func local_request_WorksheetService_ListWorksheetFolders_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func local_request_SavedQueryService_ListSavedQueryFolders_0(ctx context.Context, marshaler runtime.Marshaler, server SavedQueryServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq ListWorksheetFoldersRequest
+ protoReq ListSavedQueryFoldersRequest
metadata runtime.ServerMetadata
err error
)
@@ -207,13 +207,13 @@ func local_request_WorksheetService_ListWorksheetFolders_0(ctx context.Context,
if err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "parent", err)
}
- msg, err := server.ListWorksheetFolders(ctx, &protoReq)
+ msg, err := server.ListSavedQueryFolders(ctx, &protoReq)
return msg, metadata, err
}
-func request_WorksheetService_SearchWorksheets_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func request_SavedQueryService_SearchSavedQueries_0(ctx context.Context, marshaler runtime.Marshaler, client SavedQueryServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq SearchWorksheetsRequest
+ protoReq SearchSavedQueriesRequest
metadata runtime.ServerMetadata
err error
)
@@ -231,13 +231,13 @@ func request_WorksheetService_SearchWorksheets_0(ctx context.Context, marshaler
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
- msg, err := client.SearchWorksheets(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ msg, err := client.SearchSavedQueries(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
-func local_request_WorksheetService_SearchWorksheets_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func local_request_SavedQueryService_SearchSavedQueries_0(ctx context.Context, marshaler runtime.Marshaler, server SavedQueryServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq SearchWorksheetsRequest
+ protoReq SearchSavedQueriesRequest
metadata runtime.ServerMetadata
err error
)
@@ -252,15 +252,15 @@ func local_request_WorksheetService_SearchWorksheets_0(ctx context.Context, mars
if err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "parent", err)
}
- msg, err := server.SearchWorksheets(ctx, &protoReq)
+ msg, err := server.SearchSavedQueries(ctx, &protoReq)
return msg, metadata, err
}
-var filter_WorksheetService_UpdateWorksheet_0 = &utilities.DoubleArray{Encoding: map[string]int{"worksheet": 0, "name": 1}, Base: []int{1, 2, 1, 0, 0}, Check: []int{0, 1, 2, 3, 2}}
+var filter_SavedQueryService_UpdateSavedQuery_0 = &utilities.DoubleArray{Encoding: map[string]int{"saved_query": 0, "name": 1}, Base: []int{1, 2, 1, 0, 0}, Check: []int{0, 1, 2, 3, 2}}
-func request_WorksheetService_UpdateWorksheet_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func request_SavedQueryService_UpdateSavedQuery_0(ctx context.Context, marshaler runtime.Marshaler, client SavedQueryServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq UpdateWorksheetRequest
+ protoReq UpdateSavedQueryRequest
metadata runtime.ServerMetadata
err error
)
@@ -268,40 +268,40 @@ func request_WorksheetService_UpdateWorksheet_0(ctx context.Context, marshaler r
if berr != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", berr)
}
- if err := marshaler.NewDecoder(newReader()).Decode(&protoReq.Worksheet); err != nil && !errors.Is(err, io.EOF) {
+ if err := marshaler.NewDecoder(newReader()).Decode(&protoReq.SavedQuery); err != nil && !errors.Is(err, io.EOF) {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
if protoReq.UpdateMask == nil || len(protoReq.UpdateMask.GetPaths()) == 0 {
- if fieldMask, err := runtime.FieldMaskFromRequestBody(newReader(), protoReq.Worksheet); err != nil {
+ if fieldMask, err := runtime.FieldMaskFromRequestBody(newReader(), protoReq.SavedQuery); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
} else {
protoReq.UpdateMask = fieldMask
}
}
- val, ok := pathParams["worksheet.name"]
+ val, ok := pathParams["saved_query.name"]
if !ok {
- return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "worksheet.name")
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "saved_query.name")
}
- err = runtime.PopulateFieldFromPath(&protoReq, "worksheet.name", val)
+ err = runtime.PopulateFieldFromPath(&protoReq, "saved_query.name", val)
if err != nil {
- return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "worksheet.name", err)
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "saved_query.name", err)
}
if err := req.ParseForm(); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
- if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_WorksheetService_UpdateWorksheet_0); err != nil {
+ if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_SavedQueryService_UpdateSavedQuery_0); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
- msg, err := client.UpdateWorksheet(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ msg, err := client.UpdateSavedQuery(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
-func local_request_WorksheetService_UpdateWorksheet_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func local_request_SavedQueryService_UpdateSavedQuery_0(ctx context.Context, marshaler runtime.Marshaler, server SavedQueryServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq UpdateWorksheetRequest
+ protoReq UpdateSavedQueryRequest
metadata runtime.ServerMetadata
err error
)
@@ -309,39 +309,39 @@ func local_request_WorksheetService_UpdateWorksheet_0(ctx context.Context, marsh
if berr != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", berr)
}
- if err := marshaler.NewDecoder(newReader()).Decode(&protoReq.Worksheet); err != nil && !errors.Is(err, io.EOF) {
+ if err := marshaler.NewDecoder(newReader()).Decode(&protoReq.SavedQuery); err != nil && !errors.Is(err, io.EOF) {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
if protoReq.UpdateMask == nil || len(protoReq.UpdateMask.GetPaths()) == 0 {
- if fieldMask, err := runtime.FieldMaskFromRequestBody(newReader(), protoReq.Worksheet); err != nil {
+ if fieldMask, err := runtime.FieldMaskFromRequestBody(newReader(), protoReq.SavedQuery); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
} else {
protoReq.UpdateMask = fieldMask
}
}
- val, ok := pathParams["worksheet.name"]
+ val, ok := pathParams["saved_query.name"]
if !ok {
- return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "worksheet.name")
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "saved_query.name")
}
- err = runtime.PopulateFieldFromPath(&protoReq, "worksheet.name", val)
+ err = runtime.PopulateFieldFromPath(&protoReq, "saved_query.name", val)
if err != nil {
- return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "worksheet.name", err)
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "saved_query.name", err)
}
if err := req.ParseForm(); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
- if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_WorksheetService_UpdateWorksheet_0); err != nil {
+ if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_SavedQueryService_UpdateSavedQuery_0); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
- msg, err := server.UpdateWorksheet(ctx, &protoReq)
+ msg, err := server.UpdateSavedQuery(ctx, &protoReq)
return msg, metadata, err
}
-var filter_WorksheetService_UpdateWorksheetOrganizer_0 = &utilities.DoubleArray{Encoding: map[string]int{"organizer": 0, "worksheet": 1}, Base: []int{1, 2, 1, 0, 0}, Check: []int{0, 1, 2, 3, 2}}
+var filter_SavedQueryService_UpdateSavedQueryOrganizer_0 = &utilities.DoubleArray{Encoding: map[string]int{"organizer": 0, "saved_query": 1}, Base: []int{1, 2, 1, 0, 0}, Check: []int{0, 1, 2, 3, 2}}
-func request_WorksheetService_UpdateWorksheetOrganizer_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func request_SavedQueryService_UpdateSavedQueryOrganizer_0(ctx context.Context, marshaler runtime.Marshaler, client SavedQueryServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq UpdateWorksheetOrganizerRequest
+ protoReq UpdateSavedQueryOrganizerRequest
metadata runtime.ServerMetadata
err error
)
@@ -359,30 +359,30 @@ func request_WorksheetService_UpdateWorksheetOrganizer_0(ctx context.Context, ma
protoReq.UpdateMask = fieldMask
}
}
- val, ok := pathParams["organizer.worksheet"]
+ val, ok := pathParams["organizer.saved_query"]
if !ok {
- return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "organizer.worksheet")
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "organizer.saved_query")
}
- err = runtime.PopulateFieldFromPath(&protoReq, "organizer.worksheet", val)
+ err = runtime.PopulateFieldFromPath(&protoReq, "organizer.saved_query", val)
if err != nil {
- return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "organizer.worksheet", err)
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "organizer.saved_query", err)
}
if err := req.ParseForm(); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
- if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_WorksheetService_UpdateWorksheetOrganizer_0); err != nil {
+ if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_SavedQueryService_UpdateSavedQueryOrganizer_0); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
- msg, err := client.UpdateWorksheetOrganizer(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ msg, err := client.UpdateSavedQueryOrganizer(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
-func local_request_WorksheetService_UpdateWorksheetOrganizer_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func local_request_SavedQueryService_UpdateSavedQueryOrganizer_0(ctx context.Context, marshaler runtime.Marshaler, server SavedQueryServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq UpdateWorksheetOrganizerRequest
+ protoReq UpdateSavedQueryOrganizerRequest
metadata runtime.ServerMetadata
err error
)
@@ -400,27 +400,27 @@ func local_request_WorksheetService_UpdateWorksheetOrganizer_0(ctx context.Conte
protoReq.UpdateMask = fieldMask
}
}
- val, ok := pathParams["organizer.worksheet"]
+ val, ok := pathParams["organizer.saved_query"]
if !ok {
- return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "organizer.worksheet")
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "missing parameter %s", "organizer.saved_query")
}
- err = runtime.PopulateFieldFromPath(&protoReq, "organizer.worksheet", val)
+ err = runtime.PopulateFieldFromPath(&protoReq, "organizer.saved_query", val)
if err != nil {
- return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "organizer.worksheet", err)
+ return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "organizer.saved_query", err)
}
if err := req.ParseForm(); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
- if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_WorksheetService_UpdateWorksheetOrganizer_0); err != nil {
+ if err := runtime.PopulateQueryParameters(&protoReq, req.Form, filter_SavedQueryService_UpdateSavedQueryOrganizer_0); err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "%v", err)
}
- msg, err := server.UpdateWorksheetOrganizer(ctx, &protoReq)
+ msg, err := server.UpdateSavedQueryOrganizer(ctx, &protoReq)
return msg, metadata, err
}
-func request_WorksheetService_BatchUpdateWorksheetOrganizer_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func request_SavedQueryService_BatchUpdateSavedQueryOrganizer_0(ctx context.Context, marshaler runtime.Marshaler, client SavedQueryServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq BatchUpdateWorksheetOrganizerRequest
+ protoReq BatchUpdateSavedQueryOrganizerRequest
metadata runtime.ServerMetadata
err error
)
@@ -438,13 +438,13 @@ func request_WorksheetService_BatchUpdateWorksheetOrganizer_0(ctx context.Contex
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
- msg, err := client.BatchUpdateWorksheetOrganizer(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ msg, err := client.BatchUpdateSavedQueryOrganizer(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
-func local_request_WorksheetService_BatchUpdateWorksheetOrganizer_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func local_request_SavedQueryService_BatchUpdateSavedQueryOrganizer_0(ctx context.Context, marshaler runtime.Marshaler, server SavedQueryServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq BatchUpdateWorksheetOrganizerRequest
+ protoReq BatchUpdateSavedQueryOrganizerRequest
metadata runtime.ServerMetadata
err error
)
@@ -459,13 +459,13 @@ func local_request_WorksheetService_BatchUpdateWorksheetOrganizer_0(ctx context.
if err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "parent", err)
}
- msg, err := server.BatchUpdateWorksheetOrganizer(ctx, &protoReq)
+ msg, err := server.BatchUpdateSavedQueryOrganizer(ctx, &protoReq)
return msg, metadata, err
}
-func request_WorksheetService_DeleteWorksheet_0(ctx context.Context, marshaler runtime.Marshaler, client WorksheetServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func request_SavedQueryService_DeleteSavedQuery_0(ctx context.Context, marshaler runtime.Marshaler, client SavedQueryServiceClient, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq DeleteWorksheetRequest
+ protoReq DeleteSavedQueryRequest
metadata runtime.ServerMetadata
err error
)
@@ -480,13 +480,13 @@ func request_WorksheetService_DeleteWorksheet_0(ctx context.Context, marshaler r
if req.Body != nil {
_, _ = io.Copy(io.Discard, req.Body)
}
- msg, err := client.DeleteWorksheet(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
+ msg, err := client.DeleteSavedQuery(ctx, &protoReq, grpc.Header(&metadata.HeaderMD), grpc.Trailer(&metadata.TrailerMD))
return msg, metadata, err
}
-func local_request_WorksheetService_DeleteWorksheet_0(ctx context.Context, marshaler runtime.Marshaler, server WorksheetServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
+func local_request_SavedQueryService_DeleteSavedQuery_0(ctx context.Context, marshaler runtime.Marshaler, server SavedQueryServiceServer, req *http.Request, pathParams map[string]string) (proto.Message, runtime.ServerMetadata, error) {
var (
- protoReq DeleteWorksheetRequest
+ protoReq DeleteSavedQueryRequest
metadata runtime.ServerMetadata
err error
)
@@ -498,203 +498,203 @@ func local_request_WorksheetService_DeleteWorksheet_0(ctx context.Context, marsh
if err != nil {
return nil, metadata, status.Errorf(codes.InvalidArgument, "type mismatch, parameter: %s, error: %v", "name", err)
}
- msg, err := server.DeleteWorksheet(ctx, &protoReq)
+ msg, err := server.DeleteSavedQuery(ctx, &protoReq)
return msg, metadata, err
}
-// RegisterWorksheetServiceHandlerServer registers the http handlers for service WorksheetService to "mux".
-// UnaryRPC :call WorksheetServiceServer directly.
+// RegisterSavedQueryServiceHandlerServer registers the http handlers for service SavedQueryService to "mux".
+// UnaryRPC :call SavedQueryServiceServer directly.
// StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.
-// Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterWorksheetServiceHandlerFromEndpoint instead.
+// Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterSavedQueryServiceHandlerFromEndpoint instead.
// GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.
-func RegisterWorksheetServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server WorksheetServiceServer) error {
- mux.Handle(http.MethodPost, pattern_WorksheetService_CreateWorksheet_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+func RegisterSavedQueryServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SavedQueryServiceServer) error {
+ mux.Handle(http.MethodPost, pattern_SavedQueryService_CreateSavedQuery_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/CreateWorksheet", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/CreateSavedQuery", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueries"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := local_request_WorksheetService_CreateWorksheet_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ resp, md, err := local_request_SavedQueryService_CreateSavedQuery_0(annotatedContext, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_CreateWorksheet_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_CreateSavedQuery_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodGet, pattern_WorksheetService_GetWorksheet_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodGet, pattern_SavedQueryService_GetSavedQuery_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/GetWorksheet", runtime.WithHTTPPathPattern("/v1/{name=projects/*/worksheets/*}"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/GetSavedQuery", runtime.WithHTTPPathPattern("/v1/{name=projects/*/savedQueries/*}"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := local_request_WorksheetService_GetWorksheet_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ resp, md, err := local_request_SavedQueryService_GetSavedQuery_0(annotatedContext, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_GetWorksheet_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_GetSavedQuery_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodGet, pattern_WorksheetService_ListWorksheets_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodGet, pattern_SavedQueryService_ListSavedQueries_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/ListWorksheets", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/ListSavedQueries", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueries"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := local_request_WorksheetService_ListWorksheets_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ resp, md, err := local_request_SavedQueryService_ListSavedQueries_0(annotatedContext, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_ListWorksheets_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_ListSavedQueries_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodGet, pattern_WorksheetService_ListWorksheetFolders_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodGet, pattern_SavedQueryService_ListSavedQueryFolders_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/ListWorksheetFolders", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheetFolders"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/ListSavedQueryFolders", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueryFolders"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := local_request_WorksheetService_ListWorksheetFolders_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ resp, md, err := local_request_SavedQueryService_ListSavedQueryFolders_0(annotatedContext, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_ListWorksheetFolders_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_ListSavedQueryFolders_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPost, pattern_WorksheetService_SearchWorksheets_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPost, pattern_SavedQueryService_SearchSavedQueries_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/SearchWorksheets", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets:search"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/SearchSavedQueries", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueries:search"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := local_request_WorksheetService_SearchWorksheets_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ resp, md, err := local_request_SavedQueryService_SearchSavedQueries_0(annotatedContext, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_SearchWorksheets_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_SearchSavedQueries_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPatch, pattern_WorksheetService_UpdateWorksheet_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPatch, pattern_SavedQueryService_UpdateSavedQuery_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/UpdateWorksheet", runtime.WithHTTPPathPattern("/v1/{worksheet.name=projects/*/worksheets/*}"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/UpdateSavedQuery", runtime.WithHTTPPathPattern("/v1/{saved_query.name=projects/*/savedQueries/*}"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := local_request_WorksheetService_UpdateWorksheet_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ resp, md, err := local_request_SavedQueryService_UpdateSavedQuery_0(annotatedContext, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_UpdateWorksheet_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_UpdateSavedQuery_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPatch, pattern_WorksheetService_UpdateWorksheetOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPatch, pattern_SavedQueryService_UpdateSavedQueryOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/UpdateWorksheetOrganizer", runtime.WithHTTPPathPattern("/v1/{organizer.worksheet=projects/*/worksheets/*}/organizer"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/UpdateSavedQueryOrganizer", runtime.WithHTTPPathPattern("/v1/{organizer.saved_query=projects/*/savedQueries/*}/organizer"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := local_request_WorksheetService_UpdateWorksheetOrganizer_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ resp, md, err := local_request_SavedQueryService_UpdateSavedQueryOrganizer_0(annotatedContext, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_UpdateWorksheetOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_UpdateSavedQueryOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPost, pattern_WorksheetService_BatchUpdateWorksheetOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPost, pattern_SavedQueryService_BatchUpdateSavedQueryOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/BatchUpdateWorksheetOrganizer", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets/organizers:batchUpdate"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/BatchUpdateSavedQueryOrganizer", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueries/organizers:batchUpdate"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := local_request_WorksheetService_BatchUpdateWorksheetOrganizer_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ resp, md, err := local_request_SavedQueryService_BatchUpdateSavedQueryOrganizer_0(annotatedContext, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_BatchUpdateWorksheetOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_BatchUpdateSavedQueryOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodDelete, pattern_WorksheetService_DeleteWorksheet_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodDelete, pattern_SavedQueryService_DeleteSavedQuery_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
var stream runtime.ServerTransportStream
ctx = grpc.NewContextWithServerTransportStream(ctx, &stream)
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.WorksheetService/DeleteWorksheet", runtime.WithHTTPPathPattern("/v1/{name=projects/*/worksheets/*}"))
+ annotatedContext, err := runtime.AnnotateIncomingContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/DeleteSavedQuery", runtime.WithHTTPPathPattern("/v1/{name=projects/*/savedQueries/*}"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := local_request_WorksheetService_DeleteWorksheet_0(annotatedContext, inboundMarshaler, server, req, pathParams)
+ resp, md, err := local_request_SavedQueryService_DeleteSavedQuery_0(annotatedContext, inboundMarshaler, server, req, pathParams)
md.HeaderMD, md.TrailerMD = metadata.Join(md.HeaderMD, stream.Header()), metadata.Join(md.TrailerMD, stream.Trailer())
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_DeleteWorksheet_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_DeleteSavedQuery_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
return nil
}
-// RegisterWorksheetServiceHandlerFromEndpoint is same as RegisterWorksheetServiceHandler but
+// RegisterSavedQueryServiceHandlerFromEndpoint is same as RegisterSavedQueryServiceHandler but
// automatically dials to "endpoint" and closes the connection when "ctx" gets done.
-func RegisterWorksheetServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
+func RegisterSavedQueryServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error) {
conn, err := grpc.NewClient(endpoint, opts...)
if err != nil {
return err
@@ -713,197 +713,197 @@ func RegisterWorksheetServiceHandlerFromEndpoint(ctx context.Context, mux *runti
}
}()
}()
- return RegisterWorksheetServiceHandler(ctx, mux, conn)
+ return RegisterSavedQueryServiceHandler(ctx, mux, conn)
}
-// RegisterWorksheetServiceHandler registers the http handlers for service WorksheetService to "mux".
+// RegisterSavedQueryServiceHandler registers the http handlers for service SavedQueryService to "mux".
// The handlers forward requests to the grpc endpoint over "conn".
-func RegisterWorksheetServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error {
- return RegisterWorksheetServiceHandlerClient(ctx, mux, NewWorksheetServiceClient(conn))
+func RegisterSavedQueryServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error {
+ return RegisterSavedQueryServiceHandlerClient(ctx, mux, NewSavedQueryServiceClient(conn))
}
-// RegisterWorksheetServiceHandlerClient registers the http handlers for service WorksheetService
-// to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "WorksheetServiceClient".
-// Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "WorksheetServiceClient"
+// RegisterSavedQueryServiceHandlerClient registers the http handlers for service SavedQueryService
+// to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "SavedQueryServiceClient".
+// Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "SavedQueryServiceClient"
// doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in
-// "WorksheetServiceClient" to call the correct interceptors. This client ignores the HTTP middlewares.
-func RegisterWorksheetServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client WorksheetServiceClient) error {
- mux.Handle(http.MethodPost, pattern_WorksheetService_CreateWorksheet_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+// "SavedQueryServiceClient" to call the correct interceptors. This client ignores the HTTP middlewares.
+func RegisterSavedQueryServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SavedQueryServiceClient) error {
+ mux.Handle(http.MethodPost, pattern_SavedQueryService_CreateSavedQuery_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/CreateWorksheet", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/CreateSavedQuery", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueries"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := request_WorksheetService_CreateWorksheet_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ resp, md, err := request_SavedQueryService_CreateSavedQuery_0(annotatedContext, inboundMarshaler, client, req, pathParams)
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_CreateWorksheet_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_CreateSavedQuery_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodGet, pattern_WorksheetService_GetWorksheet_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodGet, pattern_SavedQueryService_GetSavedQuery_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/GetWorksheet", runtime.WithHTTPPathPattern("/v1/{name=projects/*/worksheets/*}"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/GetSavedQuery", runtime.WithHTTPPathPattern("/v1/{name=projects/*/savedQueries/*}"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := request_WorksheetService_GetWorksheet_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ resp, md, err := request_SavedQueryService_GetSavedQuery_0(annotatedContext, inboundMarshaler, client, req, pathParams)
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_GetWorksheet_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_GetSavedQuery_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodGet, pattern_WorksheetService_ListWorksheets_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodGet, pattern_SavedQueryService_ListSavedQueries_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/ListWorksheets", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/ListSavedQueries", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueries"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := request_WorksheetService_ListWorksheets_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ resp, md, err := request_SavedQueryService_ListSavedQueries_0(annotatedContext, inboundMarshaler, client, req, pathParams)
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_ListWorksheets_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_ListSavedQueries_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodGet, pattern_WorksheetService_ListWorksheetFolders_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodGet, pattern_SavedQueryService_ListSavedQueryFolders_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/ListWorksheetFolders", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheetFolders"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/ListSavedQueryFolders", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueryFolders"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := request_WorksheetService_ListWorksheetFolders_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ resp, md, err := request_SavedQueryService_ListSavedQueryFolders_0(annotatedContext, inboundMarshaler, client, req, pathParams)
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_ListWorksheetFolders_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_ListSavedQueryFolders_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPost, pattern_WorksheetService_SearchWorksheets_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPost, pattern_SavedQueryService_SearchSavedQueries_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/SearchWorksheets", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets:search"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/SearchSavedQueries", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueries:search"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := request_WorksheetService_SearchWorksheets_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ resp, md, err := request_SavedQueryService_SearchSavedQueries_0(annotatedContext, inboundMarshaler, client, req, pathParams)
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_SearchWorksheets_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_SearchSavedQueries_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPatch, pattern_WorksheetService_UpdateWorksheet_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPatch, pattern_SavedQueryService_UpdateSavedQuery_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/UpdateWorksheet", runtime.WithHTTPPathPattern("/v1/{worksheet.name=projects/*/worksheets/*}"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/UpdateSavedQuery", runtime.WithHTTPPathPattern("/v1/{saved_query.name=projects/*/savedQueries/*}"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := request_WorksheetService_UpdateWorksheet_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ resp, md, err := request_SavedQueryService_UpdateSavedQuery_0(annotatedContext, inboundMarshaler, client, req, pathParams)
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_UpdateWorksheet_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_UpdateSavedQuery_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPatch, pattern_WorksheetService_UpdateWorksheetOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPatch, pattern_SavedQueryService_UpdateSavedQueryOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/UpdateWorksheetOrganizer", runtime.WithHTTPPathPattern("/v1/{organizer.worksheet=projects/*/worksheets/*}/organizer"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/UpdateSavedQueryOrganizer", runtime.WithHTTPPathPattern("/v1/{organizer.saved_query=projects/*/savedQueries/*}/organizer"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := request_WorksheetService_UpdateWorksheetOrganizer_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ resp, md, err := request_SavedQueryService_UpdateSavedQueryOrganizer_0(annotatedContext, inboundMarshaler, client, req, pathParams)
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_UpdateWorksheetOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_UpdateSavedQueryOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodPost, pattern_WorksheetService_BatchUpdateWorksheetOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodPost, pattern_SavedQueryService_BatchUpdateSavedQueryOrganizer_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/BatchUpdateWorksheetOrganizer", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/worksheets/organizers:batchUpdate"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/BatchUpdateSavedQueryOrganizer", runtime.WithHTTPPathPattern("/v1/{parent=projects/*}/savedQueries/organizers:batchUpdate"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := request_WorksheetService_BatchUpdateWorksheetOrganizer_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ resp, md, err := request_SavedQueryService_BatchUpdateSavedQueryOrganizer_0(annotatedContext, inboundMarshaler, client, req, pathParams)
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_BatchUpdateWorksheetOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_BatchUpdateSavedQueryOrganizer_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
- mux.Handle(http.MethodDelete, pattern_WorksheetService_DeleteWorksheet_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
+ mux.Handle(http.MethodDelete, pattern_SavedQueryService_DeleteSavedQuery_0, func(w http.ResponseWriter, req *http.Request, pathParams map[string]string) {
ctx, cancel := context.WithCancel(req.Context())
defer cancel()
inboundMarshaler, outboundMarshaler := runtime.MarshalerForRequest(mux, req)
- annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.WorksheetService/DeleteWorksheet", runtime.WithHTTPPathPattern("/v1/{name=projects/*/worksheets/*}"))
+ annotatedContext, err := runtime.AnnotateContext(ctx, mux, req, "/bytebase.v1.SavedQueryService/DeleteSavedQuery", runtime.WithHTTPPathPattern("/v1/{name=projects/*/savedQueries/*}"))
if err != nil {
runtime.HTTPError(ctx, mux, outboundMarshaler, w, req, err)
return
}
- resp, md, err := request_WorksheetService_DeleteWorksheet_0(annotatedContext, inboundMarshaler, client, req, pathParams)
+ resp, md, err := request_SavedQueryService_DeleteSavedQuery_0(annotatedContext, inboundMarshaler, client, req, pathParams)
annotatedContext = runtime.NewServerMetadataContext(annotatedContext, md)
if err != nil {
runtime.HTTPError(annotatedContext, mux, outboundMarshaler, w, req, err)
return
}
- forward_WorksheetService_DeleteWorksheet_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
+ forward_SavedQueryService_DeleteSavedQuery_0(annotatedContext, mux, outboundMarshaler, w, req, resp, mux.GetForwardResponseOptions()...)
})
return nil
}
var (
- pattern_WorksheetService_CreateWorksheet_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "worksheets"}, ""))
- pattern_WorksheetService_GetWorksheet_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3}, []string{"v1", "projects", "worksheets", "name"}, ""))
- pattern_WorksheetService_ListWorksheets_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "worksheets"}, ""))
- pattern_WorksheetService_ListWorksheetFolders_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "worksheetFolders"}, ""))
- pattern_WorksheetService_SearchWorksheets_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "worksheets"}, "search"))
- pattern_WorksheetService_UpdateWorksheet_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3}, []string{"v1", "projects", "worksheets", "worksheet.name"}, ""))
- pattern_WorksheetService_UpdateWorksheetOrganizer_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3, 2, 4}, []string{"v1", "projects", "worksheets", "organizer.worksheet", "organizer"}, ""))
- pattern_WorksheetService_BatchUpdateWorksheetOrganizer_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3, 2, 4}, []string{"v1", "projects", "parent", "worksheets", "organizers"}, "batchUpdate"))
- pattern_WorksheetService_DeleteWorksheet_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3}, []string{"v1", "projects", "worksheets", "name"}, ""))
+ pattern_SavedQueryService_CreateSavedQuery_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "savedQueries"}, ""))
+ pattern_SavedQueryService_GetSavedQuery_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3}, []string{"v1", "projects", "savedQueries", "name"}, ""))
+ pattern_SavedQueryService_ListSavedQueries_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "savedQueries"}, ""))
+ pattern_SavedQueryService_ListSavedQueryFolders_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "savedQueryFolders"}, ""))
+ pattern_SavedQueryService_SearchSavedQueries_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3}, []string{"v1", "projects", "parent", "savedQueries"}, "search"))
+ pattern_SavedQueryService_UpdateSavedQuery_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3}, []string{"v1", "projects", "savedQueries", "saved_query.name"}, ""))
+ pattern_SavedQueryService_UpdateSavedQueryOrganizer_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3, 2, 4}, []string{"v1", "projects", "savedQueries", "organizer.saved_query", "organizer"}, ""))
+ pattern_SavedQueryService_BatchUpdateSavedQueryOrganizer_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 4, 2, 5, 2, 2, 3, 2, 4}, []string{"v1", "projects", "parent", "savedQueries", "organizers"}, "batchUpdate"))
+ pattern_SavedQueryService_DeleteSavedQuery_0 = runtime.MustPattern(runtime.NewPattern(1, []int{2, 0, 2, 1, 1, 0, 2, 2, 1, 0, 4, 4, 5, 3}, []string{"v1", "projects", "savedQueries", "name"}, ""))
)
var (
- forward_WorksheetService_CreateWorksheet_0 = runtime.ForwardResponseMessage
- forward_WorksheetService_GetWorksheet_0 = runtime.ForwardResponseMessage
- forward_WorksheetService_ListWorksheets_0 = runtime.ForwardResponseMessage
- forward_WorksheetService_ListWorksheetFolders_0 = runtime.ForwardResponseMessage
- forward_WorksheetService_SearchWorksheets_0 = runtime.ForwardResponseMessage
- forward_WorksheetService_UpdateWorksheet_0 = runtime.ForwardResponseMessage
- forward_WorksheetService_UpdateWorksheetOrganizer_0 = runtime.ForwardResponseMessage
- forward_WorksheetService_BatchUpdateWorksheetOrganizer_0 = runtime.ForwardResponseMessage
- forward_WorksheetService_DeleteWorksheet_0 = runtime.ForwardResponseMessage
+ forward_SavedQueryService_CreateSavedQuery_0 = runtime.ForwardResponseMessage
+ forward_SavedQueryService_GetSavedQuery_0 = runtime.ForwardResponseMessage
+ forward_SavedQueryService_ListSavedQueries_0 = runtime.ForwardResponseMessage
+ forward_SavedQueryService_ListSavedQueryFolders_0 = runtime.ForwardResponseMessage
+ forward_SavedQueryService_SearchSavedQueries_0 = runtime.ForwardResponseMessage
+ forward_SavedQueryService_UpdateSavedQuery_0 = runtime.ForwardResponseMessage
+ forward_SavedQueryService_UpdateSavedQueryOrganizer_0 = runtime.ForwardResponseMessage
+ forward_SavedQueryService_BatchUpdateSavedQueryOrganizer_0 = runtime.ForwardResponseMessage
+ forward_SavedQueryService_DeleteSavedQuery_0 = runtime.ForwardResponseMessage
)
diff --git a/backend/generated-go/v1/worksheet_service_equal.pb.go b/backend/generated-go/v1/saved_query_service_equal.pb.go
similarity index 74%
rename from backend/generated-go/v1/worksheet_service_equal.pb.go
rename to backend/generated-go/v1/saved_query_service_equal.pb.go
index ab65b5a1fc..cca13a28e4 100644
--- a/backend/generated-go/v1/worksheet_service_equal.pb.go
+++ b/backend/generated-go/v1/saved_query_service_equal.pb.go
@@ -1,5 +1,5 @@
// Code generated by protoc-gen-equal-go. DO NOT EDIT.
-// source: v1/worksheet_service.proto
+// source: v1/saved_query_service.proto
package v1
@@ -8,7 +8,7 @@ import (
fieldmaskpb "google.golang.org/protobuf/types/known/fieldmaskpb"
)
-func (x *CreateWorksheetRequest) Equal(y *CreateWorksheetRequest) bool {
+func (x *CreateSavedQueryRequest) Equal(y *CreateSavedQueryRequest) bool {
if x == y {
return true
}
@@ -18,13 +18,13 @@ func (x *CreateWorksheetRequest) Equal(y *CreateWorksheetRequest) bool {
if x.Parent != y.Parent {
return false
}
- if !x.Worksheet.Equal(y.Worksheet) {
+ if !x.SavedQuery.Equal(y.SavedQuery) {
return false
}
return true
}
-func (x *GetWorksheetRequest) Equal(y *GetWorksheetRequest) bool {
+func (x *GetSavedQueryRequest) Equal(y *GetSavedQueryRequest) bool {
if x == y {
return true
}
@@ -37,7 +37,7 @@ func (x *GetWorksheetRequest) Equal(y *GetWorksheetRequest) bool {
return true
}
-func (x *ListWorksheetsRequest) Equal(y *ListWorksheetsRequest) bool {
+func (x *ListSavedQueriesRequest) Equal(y *ListSavedQueriesRequest) bool {
if x == y {
return true
}
@@ -59,18 +59,18 @@ func (x *ListWorksheetsRequest) Equal(y *ListWorksheetsRequest) bool {
return true
}
-func (x *ListWorksheetsResponse) Equal(y *ListWorksheetsResponse) bool {
+func (x *ListSavedQueriesResponse) Equal(y *ListSavedQueriesResponse) bool {
if x == y {
return true
}
if x == nil || y == nil {
return x == nil && y == nil
}
- if len(x.Worksheets) != len(y.Worksheets) {
+ if len(x.SavedQueries) != len(y.SavedQueries) {
return false
}
- for i := 0; i < len(x.Worksheets); i++ {
- if !x.Worksheets[i].Equal(y.Worksheets[i]) {
+ for i := 0; i < len(x.SavedQueries); i++ {
+ if !x.SavedQueries[i].Equal(y.SavedQueries[i]) {
return false
}
}
@@ -80,7 +80,7 @@ func (x *ListWorksheetsResponse) Equal(y *ListWorksheetsResponse) bool {
return true
}
-func (x *ListWorksheetFoldersRequest) Equal(y *ListWorksheetFoldersRequest) bool {
+func (x *ListSavedQueryFoldersRequest) Equal(y *ListSavedQueryFoldersRequest) bool {
if x == y {
return true
}
@@ -93,7 +93,7 @@ func (x *ListWorksheetFoldersRequest) Equal(y *ListWorksheetFoldersRequest) bool
return true
}
-func (x *ListWorksheetFoldersResponse) Equal(y *ListWorksheetFoldersResponse) bool {
+func (x *ListSavedQueryFoldersResponse) Equal(y *ListSavedQueryFoldersResponse) bool {
if x == y {
return true
}
@@ -111,7 +111,7 @@ func (x *ListWorksheetFoldersResponse) Equal(y *ListWorksheetFoldersResponse) bo
return true
}
-func (x *WorksheetFolder) Equal(y *WorksheetFolder) bool {
+func (x *SavedQueryFolder) Equal(y *SavedQueryFolder) bool {
if x == y {
return true
}
@@ -132,14 +132,14 @@ func (x *WorksheetFolder) Equal(y *WorksheetFolder) bool {
return true
}
-func (x *UpdateWorksheetRequest) Equal(y *UpdateWorksheetRequest) bool {
+func (x *UpdateSavedQueryRequest) Equal(y *UpdateSavedQueryRequest) bool {
if x == y {
return true
}
if x == nil || y == nil {
return x == nil && y == nil
}
- if !x.Worksheet.Equal(y.Worksheet) {
+ if !x.SavedQuery.Equal(y.SavedQuery) {
return false
}
if equal, ok := interface{}(x.UpdateMask).(interface {
@@ -152,7 +152,7 @@ func (x *UpdateWorksheetRequest) Equal(y *UpdateWorksheetRequest) bool {
return true
}
-func (x *BatchUpdateWorksheetOrganizerRequest) Equal(y *BatchUpdateWorksheetOrganizerRequest) bool {
+func (x *BatchUpdateSavedQueryOrganizerRequest) Equal(y *BatchUpdateSavedQueryOrganizerRequest) bool {
if x == y {
return true
}
@@ -178,18 +178,18 @@ func (x *BatchUpdateWorksheetOrganizerRequest) Equal(y *BatchUpdateWorksheetOrga
return true
}
-func (x *BatchUpdateWorksheetOrganizerResponse) Equal(y *BatchUpdateWorksheetOrganizerResponse) bool {
+func (x *BatchUpdateSavedQueryOrganizerResponse) Equal(y *BatchUpdateSavedQueryOrganizerResponse) bool {
if x == y {
return true
}
if x == nil || y == nil {
return x == nil && y == nil
}
- if len(x.WorksheetOrganizers) != len(y.WorksheetOrganizers) {
+ if len(x.SavedQueryOrganizers) != len(y.SavedQueryOrganizers) {
return false
}
- for i := 0; i < len(x.WorksheetOrganizers); i++ {
- if !x.WorksheetOrganizers[i].Equal(y.WorksheetOrganizers[i]) {
+ for i := 0; i < len(x.SavedQueryOrganizers); i++ {
+ if !x.SavedQueryOrganizers[i].Equal(y.SavedQueryOrganizers[i]) {
return false
}
}
@@ -199,7 +199,7 @@ func (x *BatchUpdateWorksheetOrganizerResponse) Equal(y *BatchUpdateWorksheetOrg
return true
}
-func (x *UpdateWorksheetOrganizerRequest) Equal(y *UpdateWorksheetOrganizerRequest) bool {
+func (x *UpdateSavedQueryOrganizerRequest) Equal(y *UpdateSavedQueryOrganizerRequest) bool {
if x == y {
return true
}
@@ -222,14 +222,14 @@ func (x *UpdateWorksheetOrganizerRequest) Equal(y *UpdateWorksheetOrganizerReque
return true
}
-func (x *WorksheetOrganizer) Equal(y *WorksheetOrganizer) bool {
+func (x *SavedQueryOrganizer) Equal(y *SavedQueryOrganizer) bool {
if x == y {
return true
}
if x == nil || y == nil {
return x == nil && y == nil
}
- if x.Worksheet != y.Worksheet {
+ if x.SavedQuery != y.SavedQuery {
return false
}
if x.Starred != y.Starred {
@@ -246,7 +246,7 @@ func (x *WorksheetOrganizer) Equal(y *WorksheetOrganizer) bool {
return true
}
-func (x *DeleteWorksheetRequest) Equal(y *DeleteWorksheetRequest) bool {
+func (x *DeleteSavedQueryRequest) Equal(y *DeleteSavedQueryRequest) bool {
if x == y {
return true
}
@@ -259,7 +259,7 @@ func (x *DeleteWorksheetRequest) Equal(y *DeleteWorksheetRequest) bool {
return true
}
-func (x *SearchWorksheetsRequest) Equal(y *SearchWorksheetsRequest) bool {
+func (x *SearchSavedQueriesRequest) Equal(y *SearchSavedQueriesRequest) bool {
if x == y {
return true
}
@@ -281,18 +281,18 @@ func (x *SearchWorksheetsRequest) Equal(y *SearchWorksheetsRequest) bool {
return true
}
-func (x *SearchWorksheetsResponse) Equal(y *SearchWorksheetsResponse) bool {
+func (x *SearchSavedQueriesResponse) Equal(y *SearchSavedQueriesResponse) bool {
if x == y {
return true
}
if x == nil || y == nil {
return x == nil && y == nil
}
- if len(x.Worksheets) != len(y.Worksheets) {
+ if len(x.SavedQueries) != len(y.SavedQueries) {
return false
}
- for i := 0; i < len(x.Worksheets); i++ {
- if !x.Worksheets[i].Equal(y.Worksheets[i]) {
+ for i := 0; i < len(x.SavedQueries); i++ {
+ if !x.SavedQueries[i].Equal(y.SavedQueries[i]) {
return false
}
}
@@ -302,7 +302,7 @@ func (x *SearchWorksheetsResponse) Equal(y *SearchWorksheetsResponse) bool {
return true
}
-func (x *Worksheet) Equal(y *Worksheet) bool {
+func (x *SavedQuery) Equal(y *SavedQuery) bool {
if x == y {
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
new file mode 100644
index 0000000000..03b77add86
--- /dev/null
+++ b/backend/generated-go/v1/saved_query_service_grpc.pb.go
@@ -0,0 +1,498 @@
+// Code generated by protoc-gen-go-grpc. DO NOT EDIT.
+// versions:
+// - protoc-gen-go-grpc v1.6.2
+// - protoc (unknown)
+// source: v1/saved_query_service.proto
+
+package v1
+
+import (
+ context "context"
+ grpc "google.golang.org/grpc"
+ codes "google.golang.org/grpc/codes"
+ status "google.golang.org/grpc/status"
+ emptypb "google.golang.org/protobuf/types/known/emptypb"
+)
+
+// This is a compile-time assertion to ensure that this generated file
+// is compatible with the grpc package it is being compiled against.
+// Requires gRPC-Go v1.64.0 or later.
+const _ = grpc.SupportPackageIsVersion9
+
+const (
+ SavedQueryService_CreateSavedQuery_FullMethodName = "/bytebase.v1.SavedQueryService/CreateSavedQuery"
+ SavedQueryService_GetSavedQuery_FullMethodName = "/bytebase.v1.SavedQueryService/GetSavedQuery"
+ SavedQueryService_ListSavedQueries_FullMethodName = "/bytebase.v1.SavedQueryService/ListSavedQueries"
+ SavedQueryService_ListSavedQueryFolders_FullMethodName = "/bytebase.v1.SavedQueryService/ListSavedQueryFolders"
+ SavedQueryService_SearchSavedQueries_FullMethodName = "/bytebase.v1.SavedQueryService/SearchSavedQueries"
+ SavedQueryService_UpdateSavedQuery_FullMethodName = "/bytebase.v1.SavedQueryService/UpdateSavedQuery"
+ SavedQueryService_UpdateSavedQueryOrganizer_FullMethodName = "/bytebase.v1.SavedQueryService/UpdateSavedQueryOrganizer"
+ SavedQueryService_BatchUpdateSavedQueryOrganizer_FullMethodName = "/bytebase.v1.SavedQueryService/BatchUpdateSavedQueryOrganizer"
+ SavedQueryService_DeleteSavedQuery_FullMethodName = "/bytebase.v1.SavedQueryService/DeleteSavedQuery"
+)
+
+// SavedQueryServiceClient is the client API for SavedQueryService service.
+//
+// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
+//
+// SavedQueryService manages saved queries for SQL Editor query development.
+// Permission IDs still use the legacy `bb.worksheets.*` names; they are
+// renamed together with the access-model redesign and its role migration.
+type SavedQueryServiceClient interface {
+ // Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries.
+ // Permissions required: None (authenticated users only)
+ CreateSavedQuery(ctx context.Context, in *CreateSavedQueryRequest, opts ...grpc.CallOption) (*SavedQuery, error)
+ // Get a saved query by name.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.get permission on the workspace;
+ // - the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ GetSavedQuery(ctx context.Context, in *GetSavedQueryRequest, opts ...grpc.CallOption) (*SavedQuery, error)
+ // List saved queries.
+ // This is used for listing saved queries in a project, or across all projects by using `projects/-`.
+ // Permissions required: bb.worksheets.list
+ ListSavedQueries(ctx context.Context, in *ListSavedQueriesRequest, opts ...grpc.CallOption) (*ListSavedQueriesResponse, error)
+ // List the caller's saved query folders.
+ // Only folders stored in the caller's saved query organizer are returned.
+ ListSavedQueryFolders(ctx context.Context, in *ListSavedQueryFoldersRequest, opts ...grpc.CallOption) (*ListSavedQueryFoldersResponse, error)
+ // Search for saved queries.
+ // This is used for finding my saved queries or saved queries shared by other people.
+ // The saved query accessibility is the same as GetSavedQuery().
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ SearchSavedQueries(ctx context.Context, in *SearchSavedQueriesRequest, opts ...grpc.CallOption) (*SearchSavedQueriesResponse, error)
+ // Update a saved query.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.manage permission on the workspace;
+ // - the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ UpdateSavedQuery(ctx context.Context, in *UpdateSavedQueryRequest, opts ...grpc.CallOption) (*SavedQuery, error)
+ // Update the organizer of a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ UpdateSavedQueryOrganizer(ctx context.Context, in *UpdateSavedQueryOrganizerRequest, opts ...grpc.CallOption) (*SavedQueryOrganizer, error)
+ // Batch update the organizers of saved queries.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ BatchUpdateSavedQueryOrganizer(ctx context.Context, in *BatchUpdateSavedQueryOrganizerRequest, opts ...grpc.CallOption) (*BatchUpdateSavedQueryOrganizerResponse, error)
+ // Delete a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ DeleteSavedQuery(ctx context.Context, in *DeleteSavedQueryRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
+}
+
+type savedQueryServiceClient struct {
+ cc grpc.ClientConnInterface
+}
+
+func NewSavedQueryServiceClient(cc grpc.ClientConnInterface) SavedQueryServiceClient {
+ return &savedQueryServiceClient{cc}
+}
+
+func (c *savedQueryServiceClient) CreateSavedQuery(ctx context.Context, in *CreateSavedQueryRequest, opts ...grpc.CallOption) (*SavedQuery, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(SavedQuery)
+ err := c.cc.Invoke(ctx, SavedQueryService_CreateSavedQuery_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
+func (c *savedQueryServiceClient) GetSavedQuery(ctx context.Context, in *GetSavedQueryRequest, opts ...grpc.CallOption) (*SavedQuery, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(SavedQuery)
+ err := c.cc.Invoke(ctx, SavedQueryService_GetSavedQuery_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
+func (c *savedQueryServiceClient) ListSavedQueries(ctx context.Context, in *ListSavedQueriesRequest, opts ...grpc.CallOption) (*ListSavedQueriesResponse, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(ListSavedQueriesResponse)
+ err := c.cc.Invoke(ctx, SavedQueryService_ListSavedQueries_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
+func (c *savedQueryServiceClient) ListSavedQueryFolders(ctx context.Context, in *ListSavedQueryFoldersRequest, opts ...grpc.CallOption) (*ListSavedQueryFoldersResponse, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(ListSavedQueryFoldersResponse)
+ err := c.cc.Invoke(ctx, SavedQueryService_ListSavedQueryFolders_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
+func (c *savedQueryServiceClient) SearchSavedQueries(ctx context.Context, in *SearchSavedQueriesRequest, opts ...grpc.CallOption) (*SearchSavedQueriesResponse, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(SearchSavedQueriesResponse)
+ err := c.cc.Invoke(ctx, SavedQueryService_SearchSavedQueries_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
+func (c *savedQueryServiceClient) UpdateSavedQuery(ctx context.Context, in *UpdateSavedQueryRequest, opts ...grpc.CallOption) (*SavedQuery, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(SavedQuery)
+ err := c.cc.Invoke(ctx, SavedQueryService_UpdateSavedQuery_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
+func (c *savedQueryServiceClient) UpdateSavedQueryOrganizer(ctx context.Context, in *UpdateSavedQueryOrganizerRequest, opts ...grpc.CallOption) (*SavedQueryOrganizer, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(SavedQueryOrganizer)
+ err := c.cc.Invoke(ctx, SavedQueryService_UpdateSavedQueryOrganizer_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
+func (c *savedQueryServiceClient) BatchUpdateSavedQueryOrganizer(ctx context.Context, in *BatchUpdateSavedQueryOrganizerRequest, opts ...grpc.CallOption) (*BatchUpdateSavedQueryOrganizerResponse, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(BatchUpdateSavedQueryOrganizerResponse)
+ err := c.cc.Invoke(ctx, SavedQueryService_BatchUpdateSavedQueryOrganizer_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
+func (c *savedQueryServiceClient) DeleteSavedQuery(ctx context.Context, in *DeleteSavedQueryRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) {
+ cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
+ out := new(emptypb.Empty)
+ err := c.cc.Invoke(ctx, SavedQueryService_DeleteSavedQuery_FullMethodName, in, out, cOpts...)
+ if err != nil {
+ return nil, err
+ }
+ return out, nil
+}
+
+// SavedQueryServiceServer is the server API for SavedQueryService service.
+// All implementations must embed UnimplementedSavedQueryServiceServer
+// for forward compatibility.
+//
+// SavedQueryService manages saved queries for SQL Editor query development.
+// Permission IDs still use the legacy `bb.worksheets.*` names; they are
+// renamed together with the access-model redesign and its role migration.
+type SavedQueryServiceServer interface {
+ // Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries.
+ // Permissions required: None (authenticated users only)
+ CreateSavedQuery(context.Context, *CreateSavedQueryRequest) (*SavedQuery, error)
+ // Get a saved query by name.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.get permission on the workspace;
+ // - the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ GetSavedQuery(context.Context, *GetSavedQueryRequest) (*SavedQuery, error)
+ // List saved queries.
+ // This is used for listing saved queries in a project, or across all projects by using `projects/-`.
+ // Permissions required: bb.worksheets.list
+ ListSavedQueries(context.Context, *ListSavedQueriesRequest) (*ListSavedQueriesResponse, error)
+ // List the caller's saved query folders.
+ // Only folders stored in the caller's saved query organizer are returned.
+ ListSavedQueryFolders(context.Context, *ListSavedQueryFoldersRequest) (*ListSavedQueryFoldersResponse, error)
+ // Search for saved queries.
+ // This is used for finding my saved queries or saved queries shared by other people.
+ // The saved query accessibility is the same as GetSavedQuery().
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ SearchSavedQueries(context.Context, *SearchSavedQueriesRequest) (*SearchSavedQueriesResponse, error)
+ // Update a saved query.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.manage permission on the workspace;
+ // - the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ UpdateSavedQuery(context.Context, *UpdateSavedQueryRequest) (*SavedQuery, error)
+ // Update the organizer of a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ UpdateSavedQueryOrganizer(context.Context, *UpdateSavedQueryOrganizerRequest) (*SavedQueryOrganizer, error)
+ // Batch update the organizers of saved queries.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ BatchUpdateSavedQueryOrganizer(context.Context, *BatchUpdateSavedQueryOrganizerRequest) (*BatchUpdateSavedQueryOrganizerResponse, error)
+ // Delete a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ DeleteSavedQuery(context.Context, *DeleteSavedQueryRequest) (*emptypb.Empty, error)
+ mustEmbedUnimplementedSavedQueryServiceServer()
+}
+
+// UnimplementedSavedQueryServiceServer must be embedded to have
+// forward compatible implementations.
+//
+// NOTE: this should be embedded by value instead of pointer to avoid a nil
+// pointer dereference when methods are called.
+type UnimplementedSavedQueryServiceServer struct{}
+
+func (UnimplementedSavedQueryServiceServer) CreateSavedQuery(context.Context, *CreateSavedQueryRequest) (*SavedQuery, error) {
+ return nil, status.Error(codes.Unimplemented, "method CreateSavedQuery not implemented")
+}
+func (UnimplementedSavedQueryServiceServer) GetSavedQuery(context.Context, *GetSavedQueryRequest) (*SavedQuery, error) {
+ return nil, status.Error(codes.Unimplemented, "method GetSavedQuery not implemented")
+}
+func (UnimplementedSavedQueryServiceServer) ListSavedQueries(context.Context, *ListSavedQueriesRequest) (*ListSavedQueriesResponse, error) {
+ return nil, status.Error(codes.Unimplemented, "method ListSavedQueries not implemented")
+}
+func (UnimplementedSavedQueryServiceServer) ListSavedQueryFolders(context.Context, *ListSavedQueryFoldersRequest) (*ListSavedQueryFoldersResponse, error) {
+ return nil, status.Error(codes.Unimplemented, "method ListSavedQueryFolders not implemented")
+}
+func (UnimplementedSavedQueryServiceServer) SearchSavedQueries(context.Context, *SearchSavedQueriesRequest) (*SearchSavedQueriesResponse, error) {
+ return nil, status.Error(codes.Unimplemented, "method SearchSavedQueries not implemented")
+}
+func (UnimplementedSavedQueryServiceServer) UpdateSavedQuery(context.Context, *UpdateSavedQueryRequest) (*SavedQuery, error) {
+ return nil, status.Error(codes.Unimplemented, "method UpdateSavedQuery not implemented")
+}
+func (UnimplementedSavedQueryServiceServer) UpdateSavedQueryOrganizer(context.Context, *UpdateSavedQueryOrganizerRequest) (*SavedQueryOrganizer, error) {
+ return nil, status.Error(codes.Unimplemented, "method UpdateSavedQueryOrganizer not implemented")
+}
+func (UnimplementedSavedQueryServiceServer) BatchUpdateSavedQueryOrganizer(context.Context, *BatchUpdateSavedQueryOrganizerRequest) (*BatchUpdateSavedQueryOrganizerResponse, error) {
+ return nil, status.Error(codes.Unimplemented, "method BatchUpdateSavedQueryOrganizer not implemented")
+}
+func (UnimplementedSavedQueryServiceServer) DeleteSavedQuery(context.Context, *DeleteSavedQueryRequest) (*emptypb.Empty, error) {
+ return nil, status.Error(codes.Unimplemented, "method DeleteSavedQuery not implemented")
+}
+func (UnimplementedSavedQueryServiceServer) mustEmbedUnimplementedSavedQueryServiceServer() {}
+func (UnimplementedSavedQueryServiceServer) testEmbeddedByValue() {}
+
+// UnsafeSavedQueryServiceServer may be embedded to opt out of forward compatibility for this service.
+// Use of this interface is not recommended, as added methods to SavedQueryServiceServer will
+// result in compilation errors.
+type UnsafeSavedQueryServiceServer interface {
+ mustEmbedUnimplementedSavedQueryServiceServer()
+}
+
+func RegisterSavedQueryServiceServer(s grpc.ServiceRegistrar, srv SavedQueryServiceServer) {
+ // If the following call panics, it indicates UnimplementedSavedQueryServiceServer was
+ // embedded by pointer and is nil. This will cause panics if an
+ // unimplemented method is ever invoked, so we test this at initialization
+ // time to prevent it from happening at runtime later due to I/O.
+ if t, ok := srv.(interface{ testEmbeddedByValue() }); ok {
+ t.testEmbeddedByValue()
+ }
+ s.RegisterService(&SavedQueryService_ServiceDesc, srv)
+}
+
+func _SavedQueryService_CreateSavedQuery_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(CreateSavedQueryRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(SavedQueryServiceServer).CreateSavedQuery(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: SavedQueryService_CreateSavedQuery_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(SavedQueryServiceServer).CreateSavedQuery(ctx, req.(*CreateSavedQueryRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
+func _SavedQueryService_GetSavedQuery_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(GetSavedQueryRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(SavedQueryServiceServer).GetSavedQuery(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: SavedQueryService_GetSavedQuery_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(SavedQueryServiceServer).GetSavedQuery(ctx, req.(*GetSavedQueryRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
+func _SavedQueryService_ListSavedQueries_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(ListSavedQueriesRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(SavedQueryServiceServer).ListSavedQueries(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: SavedQueryService_ListSavedQueries_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(SavedQueryServiceServer).ListSavedQueries(ctx, req.(*ListSavedQueriesRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
+func _SavedQueryService_ListSavedQueryFolders_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(ListSavedQueryFoldersRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(SavedQueryServiceServer).ListSavedQueryFolders(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: SavedQueryService_ListSavedQueryFolders_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(SavedQueryServiceServer).ListSavedQueryFolders(ctx, req.(*ListSavedQueryFoldersRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
+func _SavedQueryService_SearchSavedQueries_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(SearchSavedQueriesRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(SavedQueryServiceServer).SearchSavedQueries(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: SavedQueryService_SearchSavedQueries_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(SavedQueryServiceServer).SearchSavedQueries(ctx, req.(*SearchSavedQueriesRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
+func _SavedQueryService_UpdateSavedQuery_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(UpdateSavedQueryRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(SavedQueryServiceServer).UpdateSavedQuery(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: SavedQueryService_UpdateSavedQuery_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(SavedQueryServiceServer).UpdateSavedQuery(ctx, req.(*UpdateSavedQueryRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
+func _SavedQueryService_UpdateSavedQueryOrganizer_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(UpdateSavedQueryOrganizerRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(SavedQueryServiceServer).UpdateSavedQueryOrganizer(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: SavedQueryService_UpdateSavedQueryOrganizer_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(SavedQueryServiceServer).UpdateSavedQueryOrganizer(ctx, req.(*UpdateSavedQueryOrganizerRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
+func _SavedQueryService_BatchUpdateSavedQueryOrganizer_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(BatchUpdateSavedQueryOrganizerRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(SavedQueryServiceServer).BatchUpdateSavedQueryOrganizer(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: SavedQueryService_BatchUpdateSavedQueryOrganizer_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(SavedQueryServiceServer).BatchUpdateSavedQueryOrganizer(ctx, req.(*BatchUpdateSavedQueryOrganizerRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
+func _SavedQueryService_DeleteSavedQuery_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
+ in := new(DeleteSavedQueryRequest)
+ if err := dec(in); err != nil {
+ return nil, err
+ }
+ if interceptor == nil {
+ return srv.(SavedQueryServiceServer).DeleteSavedQuery(ctx, in)
+ }
+ info := &grpc.UnaryServerInfo{
+ Server: srv,
+ FullMethod: SavedQueryService_DeleteSavedQuery_FullMethodName,
+ }
+ handler := func(ctx context.Context, req interface{}) (interface{}, error) {
+ return srv.(SavedQueryServiceServer).DeleteSavedQuery(ctx, req.(*DeleteSavedQueryRequest))
+ }
+ return interceptor(ctx, in, info, handler)
+}
+
+// SavedQueryService_ServiceDesc is the grpc.ServiceDesc for SavedQueryService service.
+// It's only intended for direct use with grpc.RegisterService,
+// and not to be introspected or modified (even as a copy)
+var SavedQueryService_ServiceDesc = grpc.ServiceDesc{
+ ServiceName: "bytebase.v1.SavedQueryService",
+ HandlerType: (*SavedQueryServiceServer)(nil),
+ Methods: []grpc.MethodDesc{
+ {
+ MethodName: "CreateSavedQuery",
+ Handler: _SavedQueryService_CreateSavedQuery_Handler,
+ },
+ {
+ MethodName: "GetSavedQuery",
+ Handler: _SavedQueryService_GetSavedQuery_Handler,
+ },
+ {
+ MethodName: "ListSavedQueries",
+ Handler: _SavedQueryService_ListSavedQueries_Handler,
+ },
+ {
+ MethodName: "ListSavedQueryFolders",
+ Handler: _SavedQueryService_ListSavedQueryFolders_Handler,
+ },
+ {
+ MethodName: "SearchSavedQueries",
+ Handler: _SavedQueryService_SearchSavedQueries_Handler,
+ },
+ {
+ MethodName: "UpdateSavedQuery",
+ Handler: _SavedQueryService_UpdateSavedQuery_Handler,
+ },
+ {
+ MethodName: "UpdateSavedQueryOrganizer",
+ Handler: _SavedQueryService_UpdateSavedQueryOrganizer_Handler,
+ },
+ {
+ MethodName: "BatchUpdateSavedQueryOrganizer",
+ Handler: _SavedQueryService_BatchUpdateSavedQueryOrganizer_Handler,
+ },
+ {
+ MethodName: "DeleteSavedQuery",
+ Handler: _SavedQueryService_DeleteSavedQuery_Handler,
+ },
+ },
+ Streams: []grpc.StreamDesc{},
+ Metadata: "v1/saved_query_service.proto",
+}
diff --git a/backend/generated-go/v1/v1connect/saved_query_service.connect.go b/backend/generated-go/v1/v1connect/saved_query_service.connect.go
new file mode 100644
index 0000000000..d8d852b7a8
--- /dev/null
+++ b/backend/generated-go/v1/v1connect/saved_query_service.connect.go
@@ -0,0 +1,407 @@
+// Code generated by protoc-gen-connect-go. DO NOT EDIT.
+//
+// Source: v1/saved_query_service.proto
+
+package v1connect
+
+import (
+ connect "connectrpc.com/connect"
+ context "context"
+ errors "errors"
+ v1 "github.com/bytebase/bytebase/backend/generated-go/v1"
+ emptypb "google.golang.org/protobuf/types/known/emptypb"
+ http "net/http"
+ strings "strings"
+)
+
+// This is a compile-time assertion to ensure that this generated file and the connect package are
+// compatible. If you get a compiler error that this constant is not defined, this code was
+// generated with a version of connect newer than the one compiled into your binary. You can fix the
+// problem by either regenerating this code with an older version of connect or updating the connect
+// version compiled into your binary.
+const _ = connect.IsAtLeastVersion1_13_0
+
+const (
+ // SavedQueryServiceName is the fully-qualified name of the SavedQueryService service.
+ SavedQueryServiceName = "bytebase.v1.SavedQueryService"
+)
+
+// These constants are the fully-qualified names of the RPCs defined in this package. They're
+// exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.
+//
+// Note that these are different from the fully-qualified method names used by
+// google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to
+// reflection-formatted method names, remove the leading slash and convert the remaining slash to a
+// period.
+const (
+ // SavedQueryServiceCreateSavedQueryProcedure is the fully-qualified name of the SavedQueryService's
+ // CreateSavedQuery RPC.
+ SavedQueryServiceCreateSavedQueryProcedure = "/bytebase.v1.SavedQueryService/CreateSavedQuery"
+ // SavedQueryServiceGetSavedQueryProcedure is the fully-qualified name of the SavedQueryService's
+ // GetSavedQuery RPC.
+ SavedQueryServiceGetSavedQueryProcedure = "/bytebase.v1.SavedQueryService/GetSavedQuery"
+ // SavedQueryServiceListSavedQueriesProcedure is the fully-qualified name of the SavedQueryService's
+ // ListSavedQueries RPC.
+ SavedQueryServiceListSavedQueriesProcedure = "/bytebase.v1.SavedQueryService/ListSavedQueries"
+ // SavedQueryServiceListSavedQueryFoldersProcedure is the fully-qualified name of the
+ // SavedQueryService's ListSavedQueryFolders RPC.
+ SavedQueryServiceListSavedQueryFoldersProcedure = "/bytebase.v1.SavedQueryService/ListSavedQueryFolders"
+ // SavedQueryServiceSearchSavedQueriesProcedure is the fully-qualified name of the
+ // SavedQueryService's SearchSavedQueries RPC.
+ SavedQueryServiceSearchSavedQueriesProcedure = "/bytebase.v1.SavedQueryService/SearchSavedQueries"
+ // SavedQueryServiceUpdateSavedQueryProcedure is the fully-qualified name of the SavedQueryService's
+ // UpdateSavedQuery RPC.
+ SavedQueryServiceUpdateSavedQueryProcedure = "/bytebase.v1.SavedQueryService/UpdateSavedQuery"
+ // SavedQueryServiceUpdateSavedQueryOrganizerProcedure is the fully-qualified name of the
+ // SavedQueryService's UpdateSavedQueryOrganizer RPC.
+ SavedQueryServiceUpdateSavedQueryOrganizerProcedure = "/bytebase.v1.SavedQueryService/UpdateSavedQueryOrganizer"
+ // SavedQueryServiceBatchUpdateSavedQueryOrganizerProcedure is the fully-qualified name of the
+ // SavedQueryService's BatchUpdateSavedQueryOrganizer RPC.
+ SavedQueryServiceBatchUpdateSavedQueryOrganizerProcedure = "/bytebase.v1.SavedQueryService/BatchUpdateSavedQueryOrganizer"
+ // SavedQueryServiceDeleteSavedQueryProcedure is the fully-qualified name of the SavedQueryService's
+ // DeleteSavedQuery RPC.
+ SavedQueryServiceDeleteSavedQueryProcedure = "/bytebase.v1.SavedQueryService/DeleteSavedQuery"
+)
+
+// SavedQueryServiceClient is a client for the bytebase.v1.SavedQueryService service.
+type SavedQueryServiceClient interface {
+ // Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries.
+ // Permissions required: None (authenticated users only)
+ CreateSavedQuery(context.Context, *connect.Request[v1.CreateSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error)
+ // Get a saved query by name.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.get permission on the workspace;
+ // - the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ GetSavedQuery(context.Context, *connect.Request[v1.GetSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error)
+ // List saved queries.
+ // This is used for listing saved queries in a project, or across all projects by using `projects/-`.
+ // Permissions required: bb.worksheets.list
+ ListSavedQueries(context.Context, *connect.Request[v1.ListSavedQueriesRequest]) (*connect.Response[v1.ListSavedQueriesResponse], error)
+ // List the caller's saved query folders.
+ // Only folders stored in the caller's saved query organizer are returned.
+ ListSavedQueryFolders(context.Context, *connect.Request[v1.ListSavedQueryFoldersRequest]) (*connect.Response[v1.ListSavedQueryFoldersResponse], error)
+ // Search for saved queries.
+ // This is used for finding my saved queries or saved queries shared by other people.
+ // The saved query accessibility is the same as GetSavedQuery().
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ SearchSavedQueries(context.Context, *connect.Request[v1.SearchSavedQueriesRequest]) (*connect.Response[v1.SearchSavedQueriesResponse], error)
+ // Update a saved query.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.manage permission on the workspace;
+ // - the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ UpdateSavedQuery(context.Context, *connect.Request[v1.UpdateSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error)
+ // Update the organizer of a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ UpdateSavedQueryOrganizer(context.Context, *connect.Request[v1.UpdateSavedQueryOrganizerRequest]) (*connect.Response[v1.SavedQueryOrganizer], error)
+ // Batch update the organizers of saved queries.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ BatchUpdateSavedQueryOrganizer(context.Context, *connect.Request[v1.BatchUpdateSavedQueryOrganizerRequest]) (*connect.Response[v1.BatchUpdateSavedQueryOrganizerResponse], error)
+ // Delete a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ DeleteSavedQuery(context.Context, *connect.Request[v1.DeleteSavedQueryRequest]) (*connect.Response[emptypb.Empty], error)
+}
+
+// NewSavedQueryServiceClient constructs a client for the bytebase.v1.SavedQueryService service. By
+// default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses,
+// and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the
+// connect.WithGRPC() or connect.WithGRPCWeb() options.
+//
+// The URL supplied here should be the base URL for the Connect or gRPC server (for example,
+// http://api.acme.com or https://acme.com/grpc).
+func NewSavedQueryServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) SavedQueryServiceClient {
+ baseURL = strings.TrimRight(baseURL, "/")
+ savedQueryServiceMethods := v1.File_v1_saved_query_service_proto.Services().ByName("SavedQueryService").Methods()
+ return &savedQueryServiceClient{
+ createSavedQuery: connect.NewClient[v1.CreateSavedQueryRequest, v1.SavedQuery](
+ httpClient,
+ baseURL+SavedQueryServiceCreateSavedQueryProcedure,
+ connect.WithSchema(savedQueryServiceMethods.ByName("CreateSavedQuery")),
+ connect.WithClientOptions(opts...),
+ ),
+ getSavedQuery: connect.NewClient[v1.GetSavedQueryRequest, v1.SavedQuery](
+ httpClient,
+ baseURL+SavedQueryServiceGetSavedQueryProcedure,
+ connect.WithSchema(savedQueryServiceMethods.ByName("GetSavedQuery")),
+ connect.WithClientOptions(opts...),
+ ),
+ listSavedQueries: connect.NewClient[v1.ListSavedQueriesRequest, v1.ListSavedQueriesResponse](
+ httpClient,
+ baseURL+SavedQueryServiceListSavedQueriesProcedure,
+ connect.WithSchema(savedQueryServiceMethods.ByName("ListSavedQueries")),
+ connect.WithClientOptions(opts...),
+ ),
+ listSavedQueryFolders: connect.NewClient[v1.ListSavedQueryFoldersRequest, v1.ListSavedQueryFoldersResponse](
+ httpClient,
+ baseURL+SavedQueryServiceListSavedQueryFoldersProcedure,
+ connect.WithSchema(savedQueryServiceMethods.ByName("ListSavedQueryFolders")),
+ connect.WithClientOptions(opts...),
+ ),
+ searchSavedQueries: connect.NewClient[v1.SearchSavedQueriesRequest, v1.SearchSavedQueriesResponse](
+ httpClient,
+ baseURL+SavedQueryServiceSearchSavedQueriesProcedure,
+ connect.WithSchema(savedQueryServiceMethods.ByName("SearchSavedQueries")),
+ connect.WithClientOptions(opts...),
+ ),
+ updateSavedQuery: connect.NewClient[v1.UpdateSavedQueryRequest, v1.SavedQuery](
+ httpClient,
+ baseURL+SavedQueryServiceUpdateSavedQueryProcedure,
+ connect.WithSchema(savedQueryServiceMethods.ByName("UpdateSavedQuery")),
+ connect.WithClientOptions(opts...),
+ ),
+ updateSavedQueryOrganizer: connect.NewClient[v1.UpdateSavedQueryOrganizerRequest, v1.SavedQueryOrganizer](
+ httpClient,
+ baseURL+SavedQueryServiceUpdateSavedQueryOrganizerProcedure,
+ connect.WithSchema(savedQueryServiceMethods.ByName("UpdateSavedQueryOrganizer")),
+ connect.WithClientOptions(opts...),
+ ),
+ batchUpdateSavedQueryOrganizer: connect.NewClient[v1.BatchUpdateSavedQueryOrganizerRequest, v1.BatchUpdateSavedQueryOrganizerResponse](
+ httpClient,
+ baseURL+SavedQueryServiceBatchUpdateSavedQueryOrganizerProcedure,
+ connect.WithSchema(savedQueryServiceMethods.ByName("BatchUpdateSavedQueryOrganizer")),
+ connect.WithClientOptions(opts...),
+ ),
+ deleteSavedQuery: connect.NewClient[v1.DeleteSavedQueryRequest, emptypb.Empty](
+ httpClient,
+ baseURL+SavedQueryServiceDeleteSavedQueryProcedure,
+ connect.WithSchema(savedQueryServiceMethods.ByName("DeleteSavedQuery")),
+ connect.WithClientOptions(opts...),
+ ),
+ }
+}
+
+// savedQueryServiceClient implements SavedQueryServiceClient.
+type savedQueryServiceClient struct {
+ createSavedQuery *connect.Client[v1.CreateSavedQueryRequest, v1.SavedQuery]
+ getSavedQuery *connect.Client[v1.GetSavedQueryRequest, v1.SavedQuery]
+ listSavedQueries *connect.Client[v1.ListSavedQueriesRequest, v1.ListSavedQueriesResponse]
+ listSavedQueryFolders *connect.Client[v1.ListSavedQueryFoldersRequest, v1.ListSavedQueryFoldersResponse]
+ searchSavedQueries *connect.Client[v1.SearchSavedQueriesRequest, v1.SearchSavedQueriesResponse]
+ updateSavedQuery *connect.Client[v1.UpdateSavedQueryRequest, v1.SavedQuery]
+ updateSavedQueryOrganizer *connect.Client[v1.UpdateSavedQueryOrganizerRequest, v1.SavedQueryOrganizer]
+ batchUpdateSavedQueryOrganizer *connect.Client[v1.BatchUpdateSavedQueryOrganizerRequest, v1.BatchUpdateSavedQueryOrganizerResponse]
+ deleteSavedQuery *connect.Client[v1.DeleteSavedQueryRequest, emptypb.Empty]
+}
+
+// CreateSavedQuery calls bytebase.v1.SavedQueryService.CreateSavedQuery.
+func (c *savedQueryServiceClient) CreateSavedQuery(ctx context.Context, req *connect.Request[v1.CreateSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error) {
+ return c.createSavedQuery.CallUnary(ctx, req)
+}
+
+// GetSavedQuery calls bytebase.v1.SavedQueryService.GetSavedQuery.
+func (c *savedQueryServiceClient) GetSavedQuery(ctx context.Context, req *connect.Request[v1.GetSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error) {
+ return c.getSavedQuery.CallUnary(ctx, req)
+}
+
+// ListSavedQueries calls bytebase.v1.SavedQueryService.ListSavedQueries.
+func (c *savedQueryServiceClient) ListSavedQueries(ctx context.Context, req *connect.Request[v1.ListSavedQueriesRequest]) (*connect.Response[v1.ListSavedQueriesResponse], error) {
+ return c.listSavedQueries.CallUnary(ctx, req)
+}
+
+// ListSavedQueryFolders calls bytebase.v1.SavedQueryService.ListSavedQueryFolders.
+func (c *savedQueryServiceClient) ListSavedQueryFolders(ctx context.Context, req *connect.Request[v1.ListSavedQueryFoldersRequest]) (*connect.Response[v1.ListSavedQueryFoldersResponse], error) {
+ return c.listSavedQueryFolders.CallUnary(ctx, req)
+}
+
+// SearchSavedQueries calls bytebase.v1.SavedQueryService.SearchSavedQueries.
+func (c *savedQueryServiceClient) SearchSavedQueries(ctx context.Context, req *connect.Request[v1.SearchSavedQueriesRequest]) (*connect.Response[v1.SearchSavedQueriesResponse], error) {
+ return c.searchSavedQueries.CallUnary(ctx, req)
+}
+
+// UpdateSavedQuery calls bytebase.v1.SavedQueryService.UpdateSavedQuery.
+func (c *savedQueryServiceClient) UpdateSavedQuery(ctx context.Context, req *connect.Request[v1.UpdateSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error) {
+ return c.updateSavedQuery.CallUnary(ctx, req)
+}
+
+// UpdateSavedQueryOrganizer calls bytebase.v1.SavedQueryService.UpdateSavedQueryOrganizer.
+func (c *savedQueryServiceClient) UpdateSavedQueryOrganizer(ctx context.Context, req *connect.Request[v1.UpdateSavedQueryOrganizerRequest]) (*connect.Response[v1.SavedQueryOrganizer], error) {
+ return c.updateSavedQueryOrganizer.CallUnary(ctx, req)
+}
+
+// BatchUpdateSavedQueryOrganizer calls
+// bytebase.v1.SavedQueryService.BatchUpdateSavedQueryOrganizer.
+func (c *savedQueryServiceClient) BatchUpdateSavedQueryOrganizer(ctx context.Context, req *connect.Request[v1.BatchUpdateSavedQueryOrganizerRequest]) (*connect.Response[v1.BatchUpdateSavedQueryOrganizerResponse], error) {
+ return c.batchUpdateSavedQueryOrganizer.CallUnary(ctx, req)
+}
+
+// DeleteSavedQuery calls bytebase.v1.SavedQueryService.DeleteSavedQuery.
+func (c *savedQueryServiceClient) DeleteSavedQuery(ctx context.Context, req *connect.Request[v1.DeleteSavedQueryRequest]) (*connect.Response[emptypb.Empty], error) {
+ return c.deleteSavedQuery.CallUnary(ctx, req)
+}
+
+// SavedQueryServiceHandler is an implementation of the bytebase.v1.SavedQueryService service.
+type SavedQueryServiceHandler interface {
+ // Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries.
+ // Permissions required: None (authenticated users only)
+ CreateSavedQuery(context.Context, *connect.Request[v1.CreateSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error)
+ // Get a saved query by name.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.get permission on the workspace;
+ // - the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ GetSavedQuery(context.Context, *connect.Request[v1.GetSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error)
+ // List saved queries.
+ // This is used for listing saved queries in a project, or across all projects by using `projects/-`.
+ // Permissions required: bb.worksheets.list
+ ListSavedQueries(context.Context, *connect.Request[v1.ListSavedQueriesRequest]) (*connect.Response[v1.ListSavedQueriesResponse], error)
+ // List the caller's saved query folders.
+ // Only folders stored in the caller's saved query organizer are returned.
+ ListSavedQueryFolders(context.Context, *connect.Request[v1.ListSavedQueryFoldersRequest]) (*connect.Response[v1.ListSavedQueryFoldersResponse], error)
+ // Search for saved queries.
+ // This is used for finding my saved queries or saved queries shared by other people.
+ // The saved query accessibility is the same as GetSavedQuery().
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ SearchSavedQueries(context.Context, *connect.Request[v1.SearchSavedQueriesRequest]) (*connect.Response[v1.SearchSavedQueriesResponse], error)
+ // Update a saved query.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.manage permission on the workspace;
+ // - the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ UpdateSavedQuery(context.Context, *connect.Request[v1.UpdateSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error)
+ // Update the organizer of a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ UpdateSavedQueryOrganizer(context.Context, *connect.Request[v1.UpdateSavedQueryOrganizerRequest]) (*connect.Response[v1.SavedQueryOrganizer], error)
+ // Batch update the organizers of saved queries.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ BatchUpdateSavedQueryOrganizer(context.Context, *connect.Request[v1.BatchUpdateSavedQueryOrganizerRequest]) (*connect.Response[v1.BatchUpdateSavedQueryOrganizerResponse], error)
+ // Delete a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ DeleteSavedQuery(context.Context, *connect.Request[v1.DeleteSavedQueryRequest]) (*connect.Response[emptypb.Empty], error)
+}
+
+// NewSavedQueryServiceHandler builds an HTTP handler from the service implementation. It returns
+// the path on which to mount the handler and the handler itself.
+//
+// By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf
+// and JSON codecs. They also support gzip compression.
+func NewSavedQueryServiceHandler(svc SavedQueryServiceHandler, opts ...connect.HandlerOption) (string, http.Handler) {
+ savedQueryServiceMethods := v1.File_v1_saved_query_service_proto.Services().ByName("SavedQueryService").Methods()
+ savedQueryServiceCreateSavedQueryHandler := connect.NewUnaryHandler(
+ SavedQueryServiceCreateSavedQueryProcedure,
+ svc.CreateSavedQuery,
+ connect.WithSchema(savedQueryServiceMethods.ByName("CreateSavedQuery")),
+ connect.WithHandlerOptions(opts...),
+ )
+ savedQueryServiceGetSavedQueryHandler := connect.NewUnaryHandler(
+ SavedQueryServiceGetSavedQueryProcedure,
+ svc.GetSavedQuery,
+ connect.WithSchema(savedQueryServiceMethods.ByName("GetSavedQuery")),
+ connect.WithHandlerOptions(opts...),
+ )
+ savedQueryServiceListSavedQueriesHandler := connect.NewUnaryHandler(
+ SavedQueryServiceListSavedQueriesProcedure,
+ svc.ListSavedQueries,
+ connect.WithSchema(savedQueryServiceMethods.ByName("ListSavedQueries")),
+ connect.WithHandlerOptions(opts...),
+ )
+ savedQueryServiceListSavedQueryFoldersHandler := connect.NewUnaryHandler(
+ SavedQueryServiceListSavedQueryFoldersProcedure,
+ svc.ListSavedQueryFolders,
+ connect.WithSchema(savedQueryServiceMethods.ByName("ListSavedQueryFolders")),
+ connect.WithHandlerOptions(opts...),
+ )
+ savedQueryServiceSearchSavedQueriesHandler := connect.NewUnaryHandler(
+ SavedQueryServiceSearchSavedQueriesProcedure,
+ svc.SearchSavedQueries,
+ connect.WithSchema(savedQueryServiceMethods.ByName("SearchSavedQueries")),
+ connect.WithHandlerOptions(opts...),
+ )
+ savedQueryServiceUpdateSavedQueryHandler := connect.NewUnaryHandler(
+ SavedQueryServiceUpdateSavedQueryProcedure,
+ svc.UpdateSavedQuery,
+ connect.WithSchema(savedQueryServiceMethods.ByName("UpdateSavedQuery")),
+ connect.WithHandlerOptions(opts...),
+ )
+ savedQueryServiceUpdateSavedQueryOrganizerHandler := connect.NewUnaryHandler(
+ SavedQueryServiceUpdateSavedQueryOrganizerProcedure,
+ svc.UpdateSavedQueryOrganizer,
+ connect.WithSchema(savedQueryServiceMethods.ByName("UpdateSavedQueryOrganizer")),
+ connect.WithHandlerOptions(opts...),
+ )
+ savedQueryServiceBatchUpdateSavedQueryOrganizerHandler := connect.NewUnaryHandler(
+ SavedQueryServiceBatchUpdateSavedQueryOrganizerProcedure,
+ svc.BatchUpdateSavedQueryOrganizer,
+ connect.WithSchema(savedQueryServiceMethods.ByName("BatchUpdateSavedQueryOrganizer")),
+ connect.WithHandlerOptions(opts...),
+ )
+ savedQueryServiceDeleteSavedQueryHandler := connect.NewUnaryHandler(
+ SavedQueryServiceDeleteSavedQueryProcedure,
+ svc.DeleteSavedQuery,
+ connect.WithSchema(savedQueryServiceMethods.ByName("DeleteSavedQuery")),
+ connect.WithHandlerOptions(opts...),
+ )
+ return "/bytebase.v1.SavedQueryService/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ switch r.URL.Path {
+ case SavedQueryServiceCreateSavedQueryProcedure:
+ savedQueryServiceCreateSavedQueryHandler.ServeHTTP(w, r)
+ case SavedQueryServiceGetSavedQueryProcedure:
+ savedQueryServiceGetSavedQueryHandler.ServeHTTP(w, r)
+ case SavedQueryServiceListSavedQueriesProcedure:
+ savedQueryServiceListSavedQueriesHandler.ServeHTTP(w, r)
+ case SavedQueryServiceListSavedQueryFoldersProcedure:
+ savedQueryServiceListSavedQueryFoldersHandler.ServeHTTP(w, r)
+ case SavedQueryServiceSearchSavedQueriesProcedure:
+ savedQueryServiceSearchSavedQueriesHandler.ServeHTTP(w, r)
+ case SavedQueryServiceUpdateSavedQueryProcedure:
+ savedQueryServiceUpdateSavedQueryHandler.ServeHTTP(w, r)
+ case SavedQueryServiceUpdateSavedQueryOrganizerProcedure:
+ savedQueryServiceUpdateSavedQueryOrganizerHandler.ServeHTTP(w, r)
+ case SavedQueryServiceBatchUpdateSavedQueryOrganizerProcedure:
+ savedQueryServiceBatchUpdateSavedQueryOrganizerHandler.ServeHTTP(w, r)
+ case SavedQueryServiceDeleteSavedQueryProcedure:
+ savedQueryServiceDeleteSavedQueryHandler.ServeHTTP(w, r)
+ default:
+ http.NotFound(w, r)
+ }
+ })
+}
+
+// UnimplementedSavedQueryServiceHandler returns CodeUnimplemented from all methods.
+type UnimplementedSavedQueryServiceHandler struct{}
+
+func (UnimplementedSavedQueryServiceHandler) CreateSavedQuery(context.Context, *connect.Request[v1.CreateSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.SavedQueryService.CreateSavedQuery is not implemented"))
+}
+
+func (UnimplementedSavedQueryServiceHandler) GetSavedQuery(context.Context, *connect.Request[v1.GetSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.SavedQueryService.GetSavedQuery is not implemented"))
+}
+
+func (UnimplementedSavedQueryServiceHandler) ListSavedQueries(context.Context, *connect.Request[v1.ListSavedQueriesRequest]) (*connect.Response[v1.ListSavedQueriesResponse], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.SavedQueryService.ListSavedQueries is not implemented"))
+}
+
+func (UnimplementedSavedQueryServiceHandler) ListSavedQueryFolders(context.Context, *connect.Request[v1.ListSavedQueryFoldersRequest]) (*connect.Response[v1.ListSavedQueryFoldersResponse], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.SavedQueryService.ListSavedQueryFolders is not implemented"))
+}
+
+func (UnimplementedSavedQueryServiceHandler) SearchSavedQueries(context.Context, *connect.Request[v1.SearchSavedQueriesRequest]) (*connect.Response[v1.SearchSavedQueriesResponse], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.SavedQueryService.SearchSavedQueries is not implemented"))
+}
+
+func (UnimplementedSavedQueryServiceHandler) UpdateSavedQuery(context.Context, *connect.Request[v1.UpdateSavedQueryRequest]) (*connect.Response[v1.SavedQuery], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.SavedQueryService.UpdateSavedQuery is not implemented"))
+}
+
+func (UnimplementedSavedQueryServiceHandler) UpdateSavedQueryOrganizer(context.Context, *connect.Request[v1.UpdateSavedQueryOrganizerRequest]) (*connect.Response[v1.SavedQueryOrganizer], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.SavedQueryService.UpdateSavedQueryOrganizer is not implemented"))
+}
+
+func (UnimplementedSavedQueryServiceHandler) BatchUpdateSavedQueryOrganizer(context.Context, *connect.Request[v1.BatchUpdateSavedQueryOrganizerRequest]) (*connect.Response[v1.BatchUpdateSavedQueryOrganizerResponse], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.SavedQueryService.BatchUpdateSavedQueryOrganizer is not implemented"))
+}
+
+func (UnimplementedSavedQueryServiceHandler) DeleteSavedQuery(context.Context, *connect.Request[v1.DeleteSavedQueryRequest]) (*connect.Response[emptypb.Empty], error) {
+ return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.SavedQueryService.DeleteSavedQuery is not implemented"))
+}
diff --git a/backend/generated-go/v1/v1connect/worksheet_service.connect.go b/backend/generated-go/v1/v1connect/worksheet_service.connect.go
deleted file mode 100644
index 3ed79bdfec..0000000000
--- a/backend/generated-go/v1/v1connect/worksheet_service.connect.go
+++ /dev/null
@@ -1,406 +0,0 @@
-// Code generated by protoc-gen-connect-go. DO NOT EDIT.
-//
-// Source: v1/worksheet_service.proto
-
-package v1connect
-
-import (
- connect "connectrpc.com/connect"
- context "context"
- errors "errors"
- v1 "github.com/bytebase/bytebase/backend/generated-go/v1"
- emptypb "google.golang.org/protobuf/types/known/emptypb"
- http "net/http"
- strings "strings"
-)
-
-// This is a compile-time assertion to ensure that this generated file and the connect package are
-// compatible. If you get a compiler error that this constant is not defined, this code was
-// generated with a version of connect newer than the one compiled into your binary. You can fix the
-// problem by either regenerating this code with an older version of connect or updating the connect
-// version compiled into your binary.
-const _ = connect.IsAtLeastVersion1_13_0
-
-const (
- // WorksheetServiceName is the fully-qualified name of the WorksheetService service.
- WorksheetServiceName = "bytebase.v1.WorksheetService"
-)
-
-// These constants are the fully-qualified names of the RPCs defined in this package. They're
-// exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.
-//
-// Note that these are different from the fully-qualified method names used by
-// google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to
-// reflection-formatted method names, remove the leading slash and convert the remaining slash to a
-// period.
-const (
- // WorksheetServiceCreateWorksheetProcedure is the fully-qualified name of the WorksheetService's
- // CreateWorksheet RPC.
- WorksheetServiceCreateWorksheetProcedure = "/bytebase.v1.WorksheetService/CreateWorksheet"
- // WorksheetServiceGetWorksheetProcedure is the fully-qualified name of the WorksheetService's
- // GetWorksheet RPC.
- WorksheetServiceGetWorksheetProcedure = "/bytebase.v1.WorksheetService/GetWorksheet"
- // WorksheetServiceListWorksheetsProcedure is the fully-qualified name of the WorksheetService's
- // ListWorksheets RPC.
- WorksheetServiceListWorksheetsProcedure = "/bytebase.v1.WorksheetService/ListWorksheets"
- // WorksheetServiceListWorksheetFoldersProcedure is the fully-qualified name of the
- // WorksheetService's ListWorksheetFolders RPC.
- WorksheetServiceListWorksheetFoldersProcedure = "/bytebase.v1.WorksheetService/ListWorksheetFolders"
- // WorksheetServiceSearchWorksheetsProcedure is the fully-qualified name of the WorksheetService's
- // SearchWorksheets RPC.
- WorksheetServiceSearchWorksheetsProcedure = "/bytebase.v1.WorksheetService/SearchWorksheets"
- // WorksheetServiceUpdateWorksheetProcedure is the fully-qualified name of the WorksheetService's
- // UpdateWorksheet RPC.
- WorksheetServiceUpdateWorksheetProcedure = "/bytebase.v1.WorksheetService/UpdateWorksheet"
- // WorksheetServiceUpdateWorksheetOrganizerProcedure is the fully-qualified name of the
- // WorksheetService's UpdateWorksheetOrganizer RPC.
- WorksheetServiceUpdateWorksheetOrganizerProcedure = "/bytebase.v1.WorksheetService/UpdateWorksheetOrganizer"
- // WorksheetServiceBatchUpdateWorksheetOrganizerProcedure is the fully-qualified name of the
- // WorksheetService's BatchUpdateWorksheetOrganizer RPC.
- WorksheetServiceBatchUpdateWorksheetOrganizerProcedure = "/bytebase.v1.WorksheetService/BatchUpdateWorksheetOrganizer"
- // WorksheetServiceDeleteWorksheetProcedure is the fully-qualified name of the WorksheetService's
- // DeleteWorksheet RPC.
- WorksheetServiceDeleteWorksheetProcedure = "/bytebase.v1.WorksheetService/DeleteWorksheet"
-)
-
-// WorksheetServiceClient is a client for the bytebase.v1.WorksheetService service.
-type WorksheetServiceClient interface {
- // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
- // Permissions required: None (authenticated users only)
- CreateWorksheet(context.Context, *connect.Request[v1.CreateWorksheetRequest]) (*connect.Response[v1.Worksheet], error)
- // Get a worksheet by name.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.get permission on the workspace;
- // - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- GetWorksheet(context.Context, *connect.Request[v1.GetWorksheetRequest]) (*connect.Response[v1.Worksheet], error)
- // List worksheets.
- // This is used for listing worksheets in a project, or across all projects by using `projects/-`.
- // Permissions required: bb.worksheets.list
- ListWorksheets(context.Context, *connect.Request[v1.ListWorksheetsRequest]) (*connect.Response[v1.ListWorksheetsResponse], error)
- // List the caller's worksheet folders.
- // Only folders stored in the caller's worksheet organizer are returned.
- ListWorksheetFolders(context.Context, *connect.Request[v1.ListWorksheetFoldersRequest]) (*connect.Response[v1.ListWorksheetFoldersResponse], error)
- // Search for worksheets.
- // This is used for finding my worksheets or worksheets shared by other people.
- // The sheet accessibility is the same as GetWorksheet().
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- SearchWorksheets(context.Context, *connect.Request[v1.SearchWorksheetsRequest]) (*connect.Response[v1.SearchWorksheetsResponse], error)
- // Update a worksheet.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.manage permission on the workspace;
- // - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- UpdateWorksheet(context.Context, *connect.Request[v1.UpdateWorksheetRequest]) (*connect.Response[v1.Worksheet], error)
- // Update the organizer of a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- UpdateWorksheetOrganizer(context.Context, *connect.Request[v1.UpdateWorksheetOrganizerRequest]) (*connect.Response[v1.WorksheetOrganizer], error)
- // Batch update the organizers of worksheets.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- BatchUpdateWorksheetOrganizer(context.Context, *connect.Request[v1.BatchUpdateWorksheetOrganizerRequest]) (*connect.Response[v1.BatchUpdateWorksheetOrganizerResponse], error)
- // Delete a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- DeleteWorksheet(context.Context, *connect.Request[v1.DeleteWorksheetRequest]) (*connect.Response[emptypb.Empty], error)
-}
-
-// NewWorksheetServiceClient constructs a client for the bytebase.v1.WorksheetService service. By
-// default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses,
-// and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the
-// connect.WithGRPC() or connect.WithGRPCWeb() options.
-//
-// The URL supplied here should be the base URL for the Connect or gRPC server (for example,
-// http://api.acme.com or https://acme.com/grpc).
-func NewWorksheetServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) WorksheetServiceClient {
- baseURL = strings.TrimRight(baseURL, "/")
- worksheetServiceMethods := v1.File_v1_worksheet_service_proto.Services().ByName("WorksheetService").Methods()
- return &worksheetServiceClient{
- createWorksheet: connect.NewClient[v1.CreateWorksheetRequest, v1.Worksheet](
- httpClient,
- baseURL+WorksheetServiceCreateWorksheetProcedure,
- connect.WithSchema(worksheetServiceMethods.ByName("CreateWorksheet")),
- connect.WithClientOptions(opts...),
- ),
- getWorksheet: connect.NewClient[v1.GetWorksheetRequest, v1.Worksheet](
- httpClient,
- baseURL+WorksheetServiceGetWorksheetProcedure,
- connect.WithSchema(worksheetServiceMethods.ByName("GetWorksheet")),
- connect.WithClientOptions(opts...),
- ),
- listWorksheets: connect.NewClient[v1.ListWorksheetsRequest, v1.ListWorksheetsResponse](
- httpClient,
- baseURL+WorksheetServiceListWorksheetsProcedure,
- connect.WithSchema(worksheetServiceMethods.ByName("ListWorksheets")),
- connect.WithClientOptions(opts...),
- ),
- listWorksheetFolders: connect.NewClient[v1.ListWorksheetFoldersRequest, v1.ListWorksheetFoldersResponse](
- httpClient,
- baseURL+WorksheetServiceListWorksheetFoldersProcedure,
- connect.WithSchema(worksheetServiceMethods.ByName("ListWorksheetFolders")),
- connect.WithClientOptions(opts...),
- ),
- searchWorksheets: connect.NewClient[v1.SearchWorksheetsRequest, v1.SearchWorksheetsResponse](
- httpClient,
- baseURL+WorksheetServiceSearchWorksheetsProcedure,
- connect.WithSchema(worksheetServiceMethods.ByName("SearchWorksheets")),
- connect.WithClientOptions(opts...),
- ),
- updateWorksheet: connect.NewClient[v1.UpdateWorksheetRequest, v1.Worksheet](
- httpClient,
- baseURL+WorksheetServiceUpdateWorksheetProcedure,
- connect.WithSchema(worksheetServiceMethods.ByName("UpdateWorksheet")),
- connect.WithClientOptions(opts...),
- ),
- updateWorksheetOrganizer: connect.NewClient[v1.UpdateWorksheetOrganizerRequest, v1.WorksheetOrganizer](
- httpClient,
- baseURL+WorksheetServiceUpdateWorksheetOrganizerProcedure,
- connect.WithSchema(worksheetServiceMethods.ByName("UpdateWorksheetOrganizer")),
- connect.WithClientOptions(opts...),
- ),
- batchUpdateWorksheetOrganizer: connect.NewClient[v1.BatchUpdateWorksheetOrganizerRequest, v1.BatchUpdateWorksheetOrganizerResponse](
- httpClient,
- baseURL+WorksheetServiceBatchUpdateWorksheetOrganizerProcedure,
- connect.WithSchema(worksheetServiceMethods.ByName("BatchUpdateWorksheetOrganizer")),
- connect.WithClientOptions(opts...),
- ),
- deleteWorksheet: connect.NewClient[v1.DeleteWorksheetRequest, emptypb.Empty](
- httpClient,
- baseURL+WorksheetServiceDeleteWorksheetProcedure,
- connect.WithSchema(worksheetServiceMethods.ByName("DeleteWorksheet")),
- connect.WithClientOptions(opts...),
- ),
- }
-}
-
-// worksheetServiceClient implements WorksheetServiceClient.
-type worksheetServiceClient struct {
- createWorksheet *connect.Client[v1.CreateWorksheetRequest, v1.Worksheet]
- getWorksheet *connect.Client[v1.GetWorksheetRequest, v1.Worksheet]
- listWorksheets *connect.Client[v1.ListWorksheetsRequest, v1.ListWorksheetsResponse]
- listWorksheetFolders *connect.Client[v1.ListWorksheetFoldersRequest, v1.ListWorksheetFoldersResponse]
- searchWorksheets *connect.Client[v1.SearchWorksheetsRequest, v1.SearchWorksheetsResponse]
- updateWorksheet *connect.Client[v1.UpdateWorksheetRequest, v1.Worksheet]
- updateWorksheetOrganizer *connect.Client[v1.UpdateWorksheetOrganizerRequest, v1.WorksheetOrganizer]
- batchUpdateWorksheetOrganizer *connect.Client[v1.BatchUpdateWorksheetOrganizerRequest, v1.BatchUpdateWorksheetOrganizerResponse]
- deleteWorksheet *connect.Client[v1.DeleteWorksheetRequest, emptypb.Empty]
-}
-
-// CreateWorksheet calls bytebase.v1.WorksheetService.CreateWorksheet.
-func (c *worksheetServiceClient) CreateWorksheet(ctx context.Context, req *connect.Request[v1.CreateWorksheetRequest]) (*connect.Response[v1.Worksheet], error) {
- return c.createWorksheet.CallUnary(ctx, req)
-}
-
-// GetWorksheet calls bytebase.v1.WorksheetService.GetWorksheet.
-func (c *worksheetServiceClient) GetWorksheet(ctx context.Context, req *connect.Request[v1.GetWorksheetRequest]) (*connect.Response[v1.Worksheet], error) {
- return c.getWorksheet.CallUnary(ctx, req)
-}
-
-// ListWorksheets calls bytebase.v1.WorksheetService.ListWorksheets.
-func (c *worksheetServiceClient) ListWorksheets(ctx context.Context, req *connect.Request[v1.ListWorksheetsRequest]) (*connect.Response[v1.ListWorksheetsResponse], error) {
- return c.listWorksheets.CallUnary(ctx, req)
-}
-
-// ListWorksheetFolders calls bytebase.v1.WorksheetService.ListWorksheetFolders.
-func (c *worksheetServiceClient) ListWorksheetFolders(ctx context.Context, req *connect.Request[v1.ListWorksheetFoldersRequest]) (*connect.Response[v1.ListWorksheetFoldersResponse], error) {
- return c.listWorksheetFolders.CallUnary(ctx, req)
-}
-
-// SearchWorksheets calls bytebase.v1.WorksheetService.SearchWorksheets.
-func (c *worksheetServiceClient) SearchWorksheets(ctx context.Context, req *connect.Request[v1.SearchWorksheetsRequest]) (*connect.Response[v1.SearchWorksheetsResponse], error) {
- return c.searchWorksheets.CallUnary(ctx, req)
-}
-
-// UpdateWorksheet calls bytebase.v1.WorksheetService.UpdateWorksheet.
-func (c *worksheetServiceClient) UpdateWorksheet(ctx context.Context, req *connect.Request[v1.UpdateWorksheetRequest]) (*connect.Response[v1.Worksheet], error) {
- return c.updateWorksheet.CallUnary(ctx, req)
-}
-
-// UpdateWorksheetOrganizer calls bytebase.v1.WorksheetService.UpdateWorksheetOrganizer.
-func (c *worksheetServiceClient) UpdateWorksheetOrganizer(ctx context.Context, req *connect.Request[v1.UpdateWorksheetOrganizerRequest]) (*connect.Response[v1.WorksheetOrganizer], error) {
- return c.updateWorksheetOrganizer.CallUnary(ctx, req)
-}
-
-// BatchUpdateWorksheetOrganizer calls bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer.
-func (c *worksheetServiceClient) BatchUpdateWorksheetOrganizer(ctx context.Context, req *connect.Request[v1.BatchUpdateWorksheetOrganizerRequest]) (*connect.Response[v1.BatchUpdateWorksheetOrganizerResponse], error) {
- return c.batchUpdateWorksheetOrganizer.CallUnary(ctx, req)
-}
-
-// DeleteWorksheet calls bytebase.v1.WorksheetService.DeleteWorksheet.
-func (c *worksheetServiceClient) DeleteWorksheet(ctx context.Context, req *connect.Request[v1.DeleteWorksheetRequest]) (*connect.Response[emptypb.Empty], error) {
- return c.deleteWorksheet.CallUnary(ctx, req)
-}
-
-// WorksheetServiceHandler is an implementation of the bytebase.v1.WorksheetService service.
-type WorksheetServiceHandler interface {
- // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
- // Permissions required: None (authenticated users only)
- CreateWorksheet(context.Context, *connect.Request[v1.CreateWorksheetRequest]) (*connect.Response[v1.Worksheet], error)
- // Get a worksheet by name.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.get permission on the workspace;
- // - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- GetWorksheet(context.Context, *connect.Request[v1.GetWorksheetRequest]) (*connect.Response[v1.Worksheet], error)
- // List worksheets.
- // This is used for listing worksheets in a project, or across all projects by using `projects/-`.
- // Permissions required: bb.worksheets.list
- ListWorksheets(context.Context, *connect.Request[v1.ListWorksheetsRequest]) (*connect.Response[v1.ListWorksheetsResponse], error)
- // List the caller's worksheet folders.
- // Only folders stored in the caller's worksheet organizer are returned.
- ListWorksheetFolders(context.Context, *connect.Request[v1.ListWorksheetFoldersRequest]) (*connect.Response[v1.ListWorksheetFoldersResponse], error)
- // Search for worksheets.
- // This is used for finding my worksheets or worksheets shared by other people.
- // The sheet accessibility is the same as GetWorksheet().
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- SearchWorksheets(context.Context, *connect.Request[v1.SearchWorksheetsRequest]) (*connect.Response[v1.SearchWorksheetsResponse], error)
- // Update a worksheet.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.manage permission on the workspace;
- // - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- UpdateWorksheet(context.Context, *connect.Request[v1.UpdateWorksheetRequest]) (*connect.Response[v1.Worksheet], error)
- // Update the organizer of a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- UpdateWorksheetOrganizer(context.Context, *connect.Request[v1.UpdateWorksheetOrganizerRequest]) (*connect.Response[v1.WorksheetOrganizer], error)
- // Batch update the organizers of worksheets.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- BatchUpdateWorksheetOrganizer(context.Context, *connect.Request[v1.BatchUpdateWorksheetOrganizerRequest]) (*connect.Response[v1.BatchUpdateWorksheetOrganizerResponse], error)
- // Delete a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- DeleteWorksheet(context.Context, *connect.Request[v1.DeleteWorksheetRequest]) (*connect.Response[emptypb.Empty], error)
-}
-
-// NewWorksheetServiceHandler builds an HTTP handler from the service implementation. It returns the
-// path on which to mount the handler and the handler itself.
-//
-// By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf
-// and JSON codecs. They also support gzip compression.
-func NewWorksheetServiceHandler(svc WorksheetServiceHandler, opts ...connect.HandlerOption) (string, http.Handler) {
- worksheetServiceMethods := v1.File_v1_worksheet_service_proto.Services().ByName("WorksheetService").Methods()
- worksheetServiceCreateWorksheetHandler := connect.NewUnaryHandler(
- WorksheetServiceCreateWorksheetProcedure,
- svc.CreateWorksheet,
- connect.WithSchema(worksheetServiceMethods.ByName("CreateWorksheet")),
- connect.WithHandlerOptions(opts...),
- )
- worksheetServiceGetWorksheetHandler := connect.NewUnaryHandler(
- WorksheetServiceGetWorksheetProcedure,
- svc.GetWorksheet,
- connect.WithSchema(worksheetServiceMethods.ByName("GetWorksheet")),
- connect.WithHandlerOptions(opts...),
- )
- worksheetServiceListWorksheetsHandler := connect.NewUnaryHandler(
- WorksheetServiceListWorksheetsProcedure,
- svc.ListWorksheets,
- connect.WithSchema(worksheetServiceMethods.ByName("ListWorksheets")),
- connect.WithHandlerOptions(opts...),
- )
- worksheetServiceListWorksheetFoldersHandler := connect.NewUnaryHandler(
- WorksheetServiceListWorksheetFoldersProcedure,
- svc.ListWorksheetFolders,
- connect.WithSchema(worksheetServiceMethods.ByName("ListWorksheetFolders")),
- connect.WithHandlerOptions(opts...),
- )
- worksheetServiceSearchWorksheetsHandler := connect.NewUnaryHandler(
- WorksheetServiceSearchWorksheetsProcedure,
- svc.SearchWorksheets,
- connect.WithSchema(worksheetServiceMethods.ByName("SearchWorksheets")),
- connect.WithHandlerOptions(opts...),
- )
- worksheetServiceUpdateWorksheetHandler := connect.NewUnaryHandler(
- WorksheetServiceUpdateWorksheetProcedure,
- svc.UpdateWorksheet,
- connect.WithSchema(worksheetServiceMethods.ByName("UpdateWorksheet")),
- connect.WithHandlerOptions(opts...),
- )
- worksheetServiceUpdateWorksheetOrganizerHandler := connect.NewUnaryHandler(
- WorksheetServiceUpdateWorksheetOrganizerProcedure,
- svc.UpdateWorksheetOrganizer,
- connect.WithSchema(worksheetServiceMethods.ByName("UpdateWorksheetOrganizer")),
- connect.WithHandlerOptions(opts...),
- )
- worksheetServiceBatchUpdateWorksheetOrganizerHandler := connect.NewUnaryHandler(
- WorksheetServiceBatchUpdateWorksheetOrganizerProcedure,
- svc.BatchUpdateWorksheetOrganizer,
- connect.WithSchema(worksheetServiceMethods.ByName("BatchUpdateWorksheetOrganizer")),
- connect.WithHandlerOptions(opts...),
- )
- worksheetServiceDeleteWorksheetHandler := connect.NewUnaryHandler(
- WorksheetServiceDeleteWorksheetProcedure,
- svc.DeleteWorksheet,
- connect.WithSchema(worksheetServiceMethods.ByName("DeleteWorksheet")),
- connect.WithHandlerOptions(opts...),
- )
- return "/bytebase.v1.WorksheetService/", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
- switch r.URL.Path {
- case WorksheetServiceCreateWorksheetProcedure:
- worksheetServiceCreateWorksheetHandler.ServeHTTP(w, r)
- case WorksheetServiceGetWorksheetProcedure:
- worksheetServiceGetWorksheetHandler.ServeHTTP(w, r)
- case WorksheetServiceListWorksheetsProcedure:
- worksheetServiceListWorksheetsHandler.ServeHTTP(w, r)
- case WorksheetServiceListWorksheetFoldersProcedure:
- worksheetServiceListWorksheetFoldersHandler.ServeHTTP(w, r)
- case WorksheetServiceSearchWorksheetsProcedure:
- worksheetServiceSearchWorksheetsHandler.ServeHTTP(w, r)
- case WorksheetServiceUpdateWorksheetProcedure:
- worksheetServiceUpdateWorksheetHandler.ServeHTTP(w, r)
- case WorksheetServiceUpdateWorksheetOrganizerProcedure:
- worksheetServiceUpdateWorksheetOrganizerHandler.ServeHTTP(w, r)
- case WorksheetServiceBatchUpdateWorksheetOrganizerProcedure:
- worksheetServiceBatchUpdateWorksheetOrganizerHandler.ServeHTTP(w, r)
- case WorksheetServiceDeleteWorksheetProcedure:
- worksheetServiceDeleteWorksheetHandler.ServeHTTP(w, r)
- default:
- http.NotFound(w, r)
- }
- })
-}
-
-// UnimplementedWorksheetServiceHandler returns CodeUnimplemented from all methods.
-type UnimplementedWorksheetServiceHandler struct{}
-
-func (UnimplementedWorksheetServiceHandler) CreateWorksheet(context.Context, *connect.Request[v1.CreateWorksheetRequest]) (*connect.Response[v1.Worksheet], error) {
- return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.CreateWorksheet is not implemented"))
-}
-
-func (UnimplementedWorksheetServiceHandler) GetWorksheet(context.Context, *connect.Request[v1.GetWorksheetRequest]) (*connect.Response[v1.Worksheet], error) {
- return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.GetWorksheet is not implemented"))
-}
-
-func (UnimplementedWorksheetServiceHandler) ListWorksheets(context.Context, *connect.Request[v1.ListWorksheetsRequest]) (*connect.Response[v1.ListWorksheetsResponse], error) {
- return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.ListWorksheets is not implemented"))
-}
-
-func (UnimplementedWorksheetServiceHandler) ListWorksheetFolders(context.Context, *connect.Request[v1.ListWorksheetFoldersRequest]) (*connect.Response[v1.ListWorksheetFoldersResponse], error) {
- return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.ListWorksheetFolders is not implemented"))
-}
-
-func (UnimplementedWorksheetServiceHandler) SearchWorksheets(context.Context, *connect.Request[v1.SearchWorksheetsRequest]) (*connect.Response[v1.SearchWorksheetsResponse], error) {
- return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.SearchWorksheets is not implemented"))
-}
-
-func (UnimplementedWorksheetServiceHandler) UpdateWorksheet(context.Context, *connect.Request[v1.UpdateWorksheetRequest]) (*connect.Response[v1.Worksheet], error) {
- return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.UpdateWorksheet is not implemented"))
-}
-
-func (UnimplementedWorksheetServiceHandler) UpdateWorksheetOrganizer(context.Context, *connect.Request[v1.UpdateWorksheetOrganizerRequest]) (*connect.Response[v1.WorksheetOrganizer], error) {
- return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.UpdateWorksheetOrganizer is not implemented"))
-}
-
-func (UnimplementedWorksheetServiceHandler) BatchUpdateWorksheetOrganizer(context.Context, *connect.Request[v1.BatchUpdateWorksheetOrganizerRequest]) (*connect.Response[v1.BatchUpdateWorksheetOrganizerResponse], error) {
- return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer is not implemented"))
-}
-
-func (UnimplementedWorksheetServiceHandler) DeleteWorksheet(context.Context, *connect.Request[v1.DeleteWorksheetRequest]) (*connect.Response[emptypb.Empty], error) {
- return nil, connect.NewError(connect.CodeUnimplemented, errors.New("bytebase.v1.WorksheetService.DeleteWorksheet is not implemented"))
-}
diff --git a/backend/generated-go/v1/worksheet_service.pb.go b/backend/generated-go/v1/worksheet_service.pb.go
deleted file mode 100644
index 662dc5c147..0000000000
--- a/backend/generated-go/v1/worksheet_service.pb.go
+++ /dev/null
@@ -1,1413 +0,0 @@
-// Code generated by protoc-gen-go. DO NOT EDIT.
-// versions:
-// protoc-gen-go v1.36.12
-// protoc (unknown)
-// source: v1/worksheet_service.proto
-
-package v1
-
-import (
- _ "buf.build/gen/go/bufbuild/protovalidate/protocolbuffers/go/buf/validate"
- _ "google.golang.org/genproto/googleapis/api/annotations"
- protoreflect "google.golang.org/protobuf/reflect/protoreflect"
- protoimpl "google.golang.org/protobuf/runtime/protoimpl"
- emptypb "google.golang.org/protobuf/types/known/emptypb"
- fieldmaskpb "google.golang.org/protobuf/types/known/fieldmaskpb"
- timestamppb "google.golang.org/protobuf/types/known/timestamppb"
- 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 WorksheetFolder_Category int32
-
-const (
- WorksheetFolder_CATEGORY_UNSPECIFIED WorksheetFolder_Category = 0
- WorksheetFolder_MINE WorksheetFolder_Category = 1
- WorksheetFolder_SHARED WorksheetFolder_Category = 2
-)
-
-// Enum value maps for WorksheetFolder_Category.
-var (
- WorksheetFolder_Category_name = map[int32]string{
- 0: "CATEGORY_UNSPECIFIED",
- 1: "MINE",
- 2: "SHARED",
- }
- WorksheetFolder_Category_value = map[string]int32{
- "CATEGORY_UNSPECIFIED": 0,
- "MINE": 1,
- "SHARED": 2,
- }
-)
-
-func (x WorksheetFolder_Category) Enum() *WorksheetFolder_Category {
- p := new(WorksheetFolder_Category)
- *p = x
- return p
-}
-
-func (x WorksheetFolder_Category) String() string {
- return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
-}
-
-func (WorksheetFolder_Category) Descriptor() protoreflect.EnumDescriptor {
- return file_v1_worksheet_service_proto_enumTypes[0].Descriptor()
-}
-
-func (WorksheetFolder_Category) Type() protoreflect.EnumType {
- return &file_v1_worksheet_service_proto_enumTypes[0]
-}
-
-func (x WorksheetFolder_Category) Number() protoreflect.EnumNumber {
- return protoreflect.EnumNumber(x)
-}
-
-// Deprecated: Use WorksheetFolder_Category.Descriptor instead.
-func (WorksheetFolder_Category) EnumDescriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{6, 0}
-}
-
-type Worksheet_Visibility int32
-
-const (
- Worksheet_VISIBILITY_UNSPECIFIED Worksheet_Visibility = 0
- // Read access in project scope, worksheet OWNER/DBA and project OWNER can read/write, other project members can read.
- Worksheet_PROJECT_READ Worksheet_Visibility = 1
- // Write access in project scope, worksheet OWNER/DBA and all members in the project can write the worksheet.
- Worksheet_PROJECT_WRITE Worksheet_Visibility = 2
- // Private, only worksheet OWNER can read/write.
- Worksheet_PRIVATE Worksheet_Visibility = 3
-)
-
-// Enum value maps for Worksheet_Visibility.
-var (
- Worksheet_Visibility_name = map[int32]string{
- 0: "VISIBILITY_UNSPECIFIED",
- 1: "PROJECT_READ",
- 2: "PROJECT_WRITE",
- 3: "PRIVATE",
- }
- Worksheet_Visibility_value = map[string]int32{
- "VISIBILITY_UNSPECIFIED": 0,
- "PROJECT_READ": 1,
- "PROJECT_WRITE": 2,
- "PRIVATE": 3,
- }
-)
-
-func (x Worksheet_Visibility) Enum() *Worksheet_Visibility {
- p := new(Worksheet_Visibility)
- *p = x
- return p
-}
-
-func (x Worksheet_Visibility) String() string {
- return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
-}
-
-func (Worksheet_Visibility) Descriptor() protoreflect.EnumDescriptor {
- return file_v1_worksheet_service_proto_enumTypes[1].Descriptor()
-}
-
-func (Worksheet_Visibility) Type() protoreflect.EnumType {
- return &file_v1_worksheet_service_proto_enumTypes[1]
-}
-
-func (x Worksheet_Visibility) Number() protoreflect.EnumNumber {
- return protoreflect.EnumNumber(x)
-}
-
-// Deprecated: Use Worksheet_Visibility.Descriptor instead.
-func (Worksheet_Visibility) EnumDescriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{15, 0}
-}
-
-type CreateWorksheetRequest struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The parent resource where this worksheet will be created.
- // Format: projects/{project}
- Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
- // The worksheet to create.
- Worksheet *Worksheet `protobuf:"bytes,2,opt,name=worksheet,proto3" json:"worksheet,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *CreateWorksheetRequest) Reset() {
- *x = CreateWorksheetRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[0]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *CreateWorksheetRequest) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*CreateWorksheetRequest) ProtoMessage() {}
-
-func (x *CreateWorksheetRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_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 CreateWorksheetRequest.ProtoReflect.Descriptor instead.
-func (*CreateWorksheetRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{0}
-}
-
-func (x *CreateWorksheetRequest) GetParent() string {
- if x != nil {
- return x.Parent
- }
- return ""
-}
-
-func (x *CreateWorksheetRequest) GetWorksheet() *Worksheet {
- if x != nil {
- return x.Worksheet
- }
- return nil
-}
-
-type GetWorksheetRequest struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The name of the worksheet to retrieve.
- // Format: projects/{project}/worksheets/{worksheet}
- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *GetWorksheetRequest) Reset() {
- *x = GetWorksheetRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[1]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *GetWorksheetRequest) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*GetWorksheetRequest) ProtoMessage() {}
-
-func (x *GetWorksheetRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[1]
- 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 GetWorksheetRequest.ProtoReflect.Descriptor instead.
-func (*GetWorksheetRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{1}
-}
-
-func (x *GetWorksheetRequest) GetName() string {
- if x != nil {
- return x.Name
- }
- return ""
-}
-
-type ListWorksheetsRequest struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The parent resource of the worksheets.
- // Format: projects/{project}
- // Use "projects/-" to list worksheets across all projects.
- Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
- // To filter the list result.
- // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- //
- // Supported filter:
- // - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- //
- // For example:
- // creator == "users/{email}"
- // creator != "users/{email}"
- Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
- // The maximum number of worksheets to return. The service may return fewer than
- // this value.
- // If unspecified, at most 10 worksheets will be returned.
- // The maximum value is 1000; values above 1000 will be coerced to 1000.
- PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
- // A page token, received from a previous `ListWorksheets` call.
- // Provide this to retrieve the subsequent page.
- //
- // When paginating, all other parameters provided to `ListWorksheets` must match
- // the call that provided the page token.
- PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *ListWorksheetsRequest) Reset() {
- *x = ListWorksheetsRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[2]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *ListWorksheetsRequest) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*ListWorksheetsRequest) ProtoMessage() {}
-
-func (x *ListWorksheetsRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[2]
- 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 ListWorksheetsRequest.ProtoReflect.Descriptor instead.
-func (*ListWorksheetsRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{2}
-}
-
-func (x *ListWorksheetsRequest) GetParent() string {
- if x != nil {
- return x.Parent
- }
- return ""
-}
-
-func (x *ListWorksheetsRequest) GetFilter() string {
- if x != nil {
- return x.Filter
- }
- return ""
-}
-
-func (x *ListWorksheetsRequest) GetPageSize() int32 {
- if x != nil {
- return x.PageSize
- }
- return 0
-}
-
-func (x *ListWorksheetsRequest) GetPageToken() string {
- if x != nil {
- return x.PageToken
- }
- return ""
-}
-
-type ListWorksheetsResponse struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The worksheets from the specified parent.
- Worksheets []*Worksheet `protobuf:"bytes,1,rep,name=worksheets,proto3" json:"worksheets,omitempty"`
- // A token to retrieve next page of worksheets.
- // Pass this value in the page_token field in the subsequent call to
- // `ListWorksheets` method to retrieve the next page of worksheets.
- NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *ListWorksheetsResponse) Reset() {
- *x = ListWorksheetsResponse{}
- mi := &file_v1_worksheet_service_proto_msgTypes[3]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *ListWorksheetsResponse) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*ListWorksheetsResponse) ProtoMessage() {}
-
-func (x *ListWorksheetsResponse) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[3]
- 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 ListWorksheetsResponse.ProtoReflect.Descriptor instead.
-func (*ListWorksheetsResponse) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{3}
-}
-
-func (x *ListWorksheetsResponse) GetWorksheets() []*Worksheet {
- if x != nil {
- return x.Worksheets
- }
- return nil
-}
-
-func (x *ListWorksheetsResponse) GetNextPageToken() string {
- if x != nil {
- return x.NextPageToken
- }
- return ""
-}
-
-type ListWorksheetFoldersRequest struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The parent resource of the worksheet folders.
- // Format: projects/{project}
- Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *ListWorksheetFoldersRequest) Reset() {
- *x = ListWorksheetFoldersRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[4]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *ListWorksheetFoldersRequest) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*ListWorksheetFoldersRequest) ProtoMessage() {}
-
-func (x *ListWorksheetFoldersRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[4]
- 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 ListWorksheetFoldersRequest.ProtoReflect.Descriptor instead.
-func (*ListWorksheetFoldersRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{4}
-}
-
-func (x *ListWorksheetFoldersRequest) GetParent() string {
- if x != nil {
- return x.Parent
- }
- return ""
-}
-
-type ListWorksheetFoldersResponse struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The caller's worksheet folders.
- Folders []*WorksheetFolder `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *ListWorksheetFoldersResponse) Reset() {
- *x = ListWorksheetFoldersResponse{}
- mi := &file_v1_worksheet_service_proto_msgTypes[5]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *ListWorksheetFoldersResponse) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*ListWorksheetFoldersResponse) ProtoMessage() {}
-
-func (x *ListWorksheetFoldersResponse) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[5]
- 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 ListWorksheetFoldersResponse.ProtoReflect.Descriptor instead.
-func (*ListWorksheetFoldersResponse) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{5}
-}
-
-func (x *ListWorksheetFoldersResponse) GetFolders() []*WorksheetFolder {
- if x != nil {
- return x.Folders
- }
- return nil
-}
-
-type WorksheetFolder struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The folder path segments.
- Folders []string `protobuf:"bytes,1,rep,name=folders,proto3" json:"folders,omitempty"`
- // The folder category.
- Category WorksheetFolder_Category `protobuf:"varint,2,opt,name=category,proto3,enum=bytebase.v1.WorksheetFolder_Category" json:"category,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *WorksheetFolder) Reset() {
- *x = WorksheetFolder{}
- mi := &file_v1_worksheet_service_proto_msgTypes[6]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *WorksheetFolder) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*WorksheetFolder) ProtoMessage() {}
-
-func (x *WorksheetFolder) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[6]
- 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 WorksheetFolder.ProtoReflect.Descriptor instead.
-func (*WorksheetFolder) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{6}
-}
-
-func (x *WorksheetFolder) GetFolders() []string {
- if x != nil {
- return x.Folders
- }
- return nil
-}
-
-func (x *WorksheetFolder) GetCategory() WorksheetFolder_Category {
- if x != nil {
- return x.Category
- }
- return WorksheetFolder_CATEGORY_UNSPECIFIED
-}
-
-type UpdateWorksheetRequest struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The worksheet to update.
- //
- // The worksheet's `name` field is used to identify the worksheet to update.
- // Format: projects/{project}/worksheets/{worksheet}
- Worksheet *Worksheet `protobuf:"bytes,1,opt,name=worksheet,proto3" json:"worksheet,omitempty"`
- // The list of fields to be updated.
- // Fields are specified relative to the worksheet.
- // (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)
- // Only support update the following fields for now:
- // - `title`
- // - `statement`
- // - `starred`
- // - `visibility`
- UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *UpdateWorksheetRequest) Reset() {
- *x = UpdateWorksheetRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[7]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *UpdateWorksheetRequest) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*UpdateWorksheetRequest) ProtoMessage() {}
-
-func (x *UpdateWorksheetRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[7]
- 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 UpdateWorksheetRequest.ProtoReflect.Descriptor instead.
-func (*UpdateWorksheetRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{7}
-}
-
-func (x *UpdateWorksheetRequest) GetWorksheet() *Worksheet {
- if x != nil {
- return x.Worksheet
- }
- return nil
-}
-
-func (x *UpdateWorksheetRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
- if x != nil {
- return x.UpdateMask
- }
- return nil
-}
-
-type BatchUpdateWorksheetOrganizerRequest struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The parent resource whose worksheets' organizers are updated.
- // Format: projects/{project}
- Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
- // To filter the batch update target.
- // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- //
- // Supported filter:
- // - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- // - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- // - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- // - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- // - folder: the worksheet organizer folder path, support exact "==" operator.
- Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
- // The organizer fields to update.
- Organizer *WorksheetOrganizer `protobuf:"bytes,3,opt,name=organizer,proto3" json:"organizer,omitempty"`
- // The list of fields to be updated.
- // Fields are specified relative to the worksheet organizer.
- // Only support update the following fields for now:
- // - `starred`
- // - `folders`
- UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,4,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *BatchUpdateWorksheetOrganizerRequest) Reset() {
- *x = BatchUpdateWorksheetOrganizerRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[8]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *BatchUpdateWorksheetOrganizerRequest) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*BatchUpdateWorksheetOrganizerRequest) ProtoMessage() {}
-
-func (x *BatchUpdateWorksheetOrganizerRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[8]
- 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 BatchUpdateWorksheetOrganizerRequest.ProtoReflect.Descriptor instead.
-func (*BatchUpdateWorksheetOrganizerRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{8}
-}
-
-func (x *BatchUpdateWorksheetOrganizerRequest) GetParent() string {
- if x != nil {
- return x.Parent
- }
- return ""
-}
-
-func (x *BatchUpdateWorksheetOrganizerRequest) GetFilter() string {
- if x != nil {
- return x.Filter
- }
- return ""
-}
-
-func (x *BatchUpdateWorksheetOrganizerRequest) GetOrganizer() *WorksheetOrganizer {
- if x != nil {
- return x.Organizer
- }
- return nil
-}
-
-func (x *BatchUpdateWorksheetOrganizerRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
- if x != nil {
- return x.UpdateMask
- }
- return nil
-}
-
-type BatchUpdateWorksheetOrganizerResponse struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- WorksheetOrganizers []*WorksheetOrganizer `protobuf:"bytes,1,rep,name=worksheet_organizers,json=worksheetOrganizers,proto3" json:"worksheet_organizers,omitempty"`
- UpdatedCount int32 `protobuf:"varint,2,opt,name=updated_count,json=updatedCount,proto3" json:"updated_count,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *BatchUpdateWorksheetOrganizerResponse) Reset() {
- *x = BatchUpdateWorksheetOrganizerResponse{}
- mi := &file_v1_worksheet_service_proto_msgTypes[9]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *BatchUpdateWorksheetOrganizerResponse) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*BatchUpdateWorksheetOrganizerResponse) ProtoMessage() {}
-
-func (x *BatchUpdateWorksheetOrganizerResponse) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[9]
- 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 BatchUpdateWorksheetOrganizerResponse.ProtoReflect.Descriptor instead.
-func (*BatchUpdateWorksheetOrganizerResponse) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{9}
-}
-
-func (x *BatchUpdateWorksheetOrganizerResponse) GetWorksheetOrganizers() []*WorksheetOrganizer {
- if x != nil {
- return x.WorksheetOrganizers
- }
- return nil
-}
-
-func (x *BatchUpdateWorksheetOrganizerResponse) GetUpdatedCount() int32 {
- if x != nil {
- return x.UpdatedCount
- }
- return 0
-}
-
-type UpdateWorksheetOrganizerRequest struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The organizer to update.
- //
- // The organizer's `worksheet` field is used to identify the worksheet.
- // Format: projects/{project}/worksheets/{worksheet}
- Organizer *WorksheetOrganizer `protobuf:"bytes,1,opt,name=organizer,proto3" json:"organizer,omitempty"`
- // The list of fields to be updated.
- // Fields are specified relative to the worksheet organizer.
- // Only support update the following fields for now:
- // - `starred`
- UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
- // If set to true, and the worksheet organizer is not found, a new worksheet organizer will be created.
- // In this situation, `update_mask` is ignored.
- AllowMissing bool `protobuf:"varint,3,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *UpdateWorksheetOrganizerRequest) Reset() {
- *x = UpdateWorksheetOrganizerRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[10]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *UpdateWorksheetOrganizerRequest) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*UpdateWorksheetOrganizerRequest) ProtoMessage() {}
-
-func (x *UpdateWorksheetOrganizerRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[10]
- 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 UpdateWorksheetOrganizerRequest.ProtoReflect.Descriptor instead.
-func (*UpdateWorksheetOrganizerRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{10}
-}
-
-func (x *UpdateWorksheetOrganizerRequest) GetOrganizer() *WorksheetOrganizer {
- if x != nil {
- return x.Organizer
- }
- return nil
-}
-
-func (x *UpdateWorksheetOrganizerRequest) GetUpdateMask() *fieldmaskpb.FieldMask {
- if x != nil {
- return x.UpdateMask
- }
- return nil
-}
-
-func (x *UpdateWorksheetOrganizerRequest) GetAllowMissing() bool {
- if x != nil {
- return x.AllowMissing
- }
- return false
-}
-
-type WorksheetOrganizer struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The name of the worksheet.
- // Format: projects/{project}/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"`
- Folders []string `protobuf:"bytes,3,rep,name=folders,proto3" json:"folders,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *WorksheetOrganizer) Reset() {
- *x = WorksheetOrganizer{}
- mi := &file_v1_worksheet_service_proto_msgTypes[11]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *WorksheetOrganizer) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*WorksheetOrganizer) ProtoMessage() {}
-
-func (x *WorksheetOrganizer) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[11]
- 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 WorksheetOrganizer.ProtoReflect.Descriptor instead.
-func (*WorksheetOrganizer) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{11}
-}
-
-func (x *WorksheetOrganizer) GetWorksheet() string {
- if x != nil {
- return x.Worksheet
- }
- return ""
-}
-
-func (x *WorksheetOrganizer) GetStarred() bool {
- if x != nil {
- return x.Starred
- }
- 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.
- // Format: projects/{project}/worksheets/{worksheet}
- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *DeleteWorksheetRequest) Reset() {
- *x = DeleteWorksheetRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[12]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *DeleteWorksheetRequest) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*DeleteWorksheetRequest) ProtoMessage() {}
-
-func (x *DeleteWorksheetRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[12]
- 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 DeleteWorksheetRequest.ProtoReflect.Descriptor instead.
-func (*DeleteWorksheetRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{12}
-}
-
-func (x *DeleteWorksheetRequest) GetName() string {
- if x != nil {
- return x.Name
- }
- return ""
-}
-
-type SearchWorksheetsRequest struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The parent resource of the worksheets.
- // Format: projects/{project}
- Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
- // To filter the search result.
- // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- //
- // Supported filter:
- // - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- // - title: the worksheet title, support "contains" operator.
- // - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- // - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- // - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- // - folder: the worksheet organizer folder path, support "==" operator.
- //
- // For example:
- // creator == "users/{email}"
- // title.contains("worksheet title")
- // creator != "users/{email}"
- // starred == true
- // starred == false
- // visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
- // visibility == "PRIVATE"
- // folder == "foo/bar"
- Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
- // The maximum number of worksheets to return. The service may return fewer than
- // this value.
- // If unspecified, at most 10 worksheets will be returned.
- // The maximum value is 1000; values above 1000 will be coerced to 1000.
- PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
- // A page token, received from a previous `SearchWorksheets` call.
- // Provide this to retrieve the subsequent page.
- PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SearchWorksheetsRequest) Reset() {
- *x = SearchWorksheetsRequest{}
- mi := &file_v1_worksheet_service_proto_msgTypes[13]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SearchWorksheetsRequest) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SearchWorksheetsRequest) ProtoMessage() {}
-
-func (x *SearchWorksheetsRequest) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[13]
- 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 SearchWorksheetsRequest.ProtoReflect.Descriptor instead.
-func (*SearchWorksheetsRequest) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{13}
-}
-
-func (x *SearchWorksheetsRequest) GetParent() string {
- if x != nil {
- return x.Parent
- }
- return ""
-}
-
-func (x *SearchWorksheetsRequest) GetFilter() string {
- if x != nil {
- return x.Filter
- }
- return ""
-}
-
-func (x *SearchWorksheetsRequest) GetPageSize() int32 {
- if x != nil {
- return x.PageSize
- }
- return 0
-}
-
-func (x *SearchWorksheetsRequest) GetPageToken() string {
- if x != nil {
- return x.PageToken
- }
- return ""
-}
-
-type SearchWorksheetsResponse struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The worksheets that matched the search criteria.
- Worksheets []*Worksheet `protobuf:"bytes,1,rep,name=worksheets,proto3" json:"worksheets,omitempty"`
- // A token to retrieve next page of worksheets.
- // Pass this value in the page_token field in the subsequent call to
- // `SearchWorksheets` method to retrieve the next page of worksheets.
- NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *SearchWorksheetsResponse) Reset() {
- *x = SearchWorksheetsResponse{}
- mi := &file_v1_worksheet_service_proto_msgTypes[14]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *SearchWorksheetsResponse) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*SearchWorksheetsResponse) ProtoMessage() {}
-
-func (x *SearchWorksheetsResponse) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[14]
- 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 SearchWorksheetsResponse.ProtoReflect.Descriptor instead.
-func (*SearchWorksheetsResponse) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{14}
-}
-
-func (x *SearchWorksheetsResponse) GetWorksheets() []*Worksheet {
- if x != nil {
- return x.Worksheets
- }
- return nil
-}
-
-func (x *SearchWorksheetsResponse) GetNextPageToken() string {
- if x != nil {
- return x.NextPageToken
- }
- return ""
-}
-
-type Worksheet struct {
- state protoimpl.MessageState `protogen:"open.v1"`
- // The name of the worksheet resource, generated by the server.
- // Canonical parent is project.
- // Format: projects/{project}/worksheets/{worksheet}
- Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
- // The project resource name.
- // Format: projects/{project}
- Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
- // The database resource name.
- // Format: instances/{instance}/databases/{database}
- // If the database parent doesn't exist, the database field is empty.
- Database string `protobuf:"bytes,3,opt,name=database,proto3" json:"database,omitempty"`
- // The title of the worksheet.
- Title string `protobuf:"bytes,4,opt,name=title,proto3" json:"title,omitempty"`
- // The creator of the Worksheet.
- // Format: users/{email}
- Creator string `protobuf:"bytes,5,opt,name=creator,proto3" json:"creator,omitempty"`
- // The create time of the worksheet.
- CreateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
- // The last update time of the worksheet.
- UpdateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
- // The content of the worksheet.
- // By default, it will be cut off in SearchWorksheet() method. If it doesn't match the `content_size`, you can
- // use GetWorksheet() request to retrieve the full content.
- Content []byte `protobuf:"bytes,8,opt,name=content,proto3" json:"content,omitempty"`
- // content_size is the full size of the content, may not match the size of the `content` field.
- 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"`
- Folders []string `protobuf:"bytes,12,rep,name=folders,proto3" json:"folders,omitempty"`
- unknownFields protoimpl.UnknownFields
- sizeCache protoimpl.SizeCache
-}
-
-func (x *Worksheet) Reset() {
- *x = Worksheet{}
- mi := &file_v1_worksheet_service_proto_msgTypes[15]
- ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
- ms.StoreMessageInfo(mi)
-}
-
-func (x *Worksheet) String() string {
- return protoimpl.X.MessageStringOf(x)
-}
-
-func (*Worksheet) ProtoMessage() {}
-
-func (x *Worksheet) ProtoReflect() protoreflect.Message {
- mi := &file_v1_worksheet_service_proto_msgTypes[15]
- 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 Worksheet.ProtoReflect.Descriptor instead.
-func (*Worksheet) Descriptor() ([]byte, []int) {
- return file_v1_worksheet_service_proto_rawDescGZIP(), []int{15}
-}
-
-func (x *Worksheet) GetName() string {
- if x != nil {
- return x.Name
- }
- return ""
-}
-
-func (x *Worksheet) GetProject() string {
- if x != nil {
- return x.Project
- }
- return ""
-}
-
-func (x *Worksheet) GetDatabase() string {
- if x != nil {
- return x.Database
- }
- return ""
-}
-
-func (x *Worksheet) GetTitle() string {
- if x != nil {
- return x.Title
- }
- return ""
-}
-
-func (x *Worksheet) GetCreator() string {
- if x != nil {
- return x.Creator
- }
- return ""
-}
-
-func (x *Worksheet) GetCreateTime() *timestamppb.Timestamp {
- if x != nil {
- return x.CreateTime
- }
- return nil
-}
-
-func (x *Worksheet) GetUpdateTime() *timestamppb.Timestamp {
- if x != nil {
- return x.UpdateTime
- }
- return nil
-}
-
-func (x *Worksheet) GetContent() []byte {
- if x != nil {
- return x.Content
- }
- return nil
-}
-
-func (x *Worksheet) GetContentSize() int64 {
- if x != nil {
- return x.ContentSize
- }
- return 0
-}
-
-func (x *Worksheet) GetVisibility() Worksheet_Visibility {
- if x != nil {
- return x.Visibility
- }
- return Worksheet_VISIBILITY_UNSPECIFIED
-}
-
-func (x *Worksheet) GetStarred() bool {
- if x != nil {
- return x.Starred
- }
- 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 = "" +
- "\n" +
- "\x1av1/worksheet_service.proto\x12\vbytebase.v1\x1a\x1bbuf/validate/validate.proto\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1bgoogle/protobuf/empty.proto\x1a google/protobuf/field_mask.proto\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x13v1/annotation.proto\"p\n" +
- "\x16CreateWorksheetRequest\x12\x1b\n" +
- "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\x06parent\x129\n" +
- "\tworksheet\x18\x02 \x01(\v2\x16.bytebase.v1.WorksheetB\x03\xe0A\x02R\tworksheet\".\n" +
- "\x13GetWorksheetRequest\x12\x17\n" +
- "\x04name\x18\x01 \x01(\tB\x03\xe0A\x02R\x04name\"\xa1\x01\n" +
- "\x15ListWorksheetsRequest\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\"x\n" +
- "\x16ListWorksheetsResponse\x126\n" +
- "\n" +
- "worksheets\x18\x01 \x03(\v2\x16.bytebase.v1.WorksheetR\n" +
- "worksheets\x12&\n" +
- "\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken\":\n" +
- "\x1bListWorksheetFoldersRequest\x12\x1b\n" +
- "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\x06parent\"V\n" +
- "\x1cListWorksheetFoldersResponse\x126\n" +
- "\afolders\x18\x01 \x03(\v2\x1c.bytebase.v1.WorksheetFolderR\afolders\"\xaa\x01\n" +
- "\x0fWorksheetFolder\x12\x18\n" +
- "\afolders\x18\x01 \x03(\tR\afolders\x12A\n" +
- "\bcategory\x18\x02 \x01(\x0e2%.bytebase.v1.WorksheetFolder.CategoryR\bcategory\":\n" +
- "\bCategory\x12\x18\n" +
- "\x14CATEGORY_UNSPECIFIED\x10\x00\x12\b\n" +
- "\x04MINE\x10\x01\x12\n" +
- "\n" +
- "\x06SHARED\x10\x02\"\x90\x01\n" +
- "\x16UpdateWorksheetRequest\x129\n" +
- "\tworksheet\x18\x01 \x01(\v2\x16.bytebase.v1.WorksheetB\x03\xe0A\x02R\tworksheet\x12;\n" +
- "\vupdate_mask\x18\x02 \x01(\v2\x1a.google.protobuf.FieldMaskR\n" +
- "updateMask\"\xe1\x01\n" +
- "$BatchUpdateWorksheetOrganizerRequest\x12\x1b\n" +
- "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\x06parent\x12\x16\n" +
- "\x06filter\x18\x02 \x01(\tR\x06filter\x12B\n" +
- "\torganizer\x18\x03 \x01(\v2\x1f.bytebase.v1.WorksheetOrganizerB\x03\xe0A\x02R\torganizer\x12@\n" +
- "\vupdate_mask\x18\x04 \x01(\v2\x1a.google.protobuf.FieldMaskB\x03\xe0A\x02R\n" +
- "updateMask\"\xa0\x01\n" +
- "%BatchUpdateWorksheetOrganizerResponse\x12R\n" +
- "\x14worksheet_organizers\x18\x01 \x03(\v2\x1f.bytebase.v1.WorksheetOrganizerR\x13worksheetOrganizers\x12#\n" +
- "\rupdated_count\x18\x02 \x01(\x05R\fupdatedCount\"\xc7\x01\n" +
- "\x1fUpdateWorksheetOrganizerRequest\x12B\n" +
- "\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\"k\n" +
- "\x12WorksheetOrganizer\x12!\n" +
- "\tworksheet\x18\x01 \x01(\tB\x03\xe0A\x02R\tworksheet\x12\x18\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\"\x8a\x01\n" +
- "\x17SearchWorksheetsRequest\x12\x1b\n" +
- "\x06parent\x18\x01 \x01(\tB\x03\xe0A\x02R\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\"z\n" +
- "\x18SearchWorksheetsResponse\x126\n" +
- "\n" +
- "worksheets\x18\x01 \x03(\v2\x16.bytebase.v1.WorksheetR\n" +
- "worksheets\x12&\n" +
- "\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken\"\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\x03R\aproject\x12\x1a\n" +
- "\bdatabase\x18\x03 \x01(\tR\bdatabase\x12!\n" +
- "\x05title\x18\x04 \x01(\tB\v\xe0A\x02\xbaH\x05r\x03\x18\xc8\x01R\x05title\x12\x1d\n" +
- "\acreator\x18\x05 \x01(\tB\x03\xe0A\x03R\acreator\x12@\n" +
- "\vcreate_time\x18\x06 \x01(\v2\x1a.google.protobuf.TimestampB\x03\xe0A\x03R\n" +
- "createTime\x12@\n" +
- "\vupdate_time\x18\a \x01(\v2\x1a.google.protobuf.TimestampB\x03\xe0A\x03R\n" +
- "updateTime\x12\x1d\n" +
- "\acontent\x18\b \x01(\fB\x03\xe0A\x02R\acontent\x12&\n" +
- "\fcontent_size\x18\t \x01(\x03B\x03\xe0A\x03R\vcontentSize\x12F\n" +
- "\n" +
- "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\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" +
- "\fPROJECT_READ\x10\x01\x12\x11\n" +
- "\rPROJECT_WRITE\x10\x02\x12\v\n" +
- "\aPRIVATE\x10\x032\xaf\f\n" +
- "\x10WorksheetService\x12\x9c\x01\n" +
- "\x0fCreateWorksheet\x12#.bytebase.v1.CreateWorksheetRequest\x1a\x16.bytebase.v1.Worksheet\"L\xdaA\x10parent,worksheet\x90\xea0\x02\x82\xd3\xe4\x93\x02/:\tworksheet\"\"/v1/{parent=projects/*}/worksheets\x12\x7f\n" +
- "\fGetWorksheet\x12 .bytebase.v1.GetWorksheetRequest\x1a\x16.bytebase.v1.Worksheet\"5\xdaA\x04name\x90\xea0\x02\x82\xd3\xe4\x93\x02$\x12\"/v1/{name=projects/*/worksheets/*}\x12\xa8\x01\n" +
- "\x0eListWorksheets\x12\".bytebase.v1.ListWorksheetsRequest\x1a#.bytebase.v1.ListWorksheetsResponse\"M\xdaA\x06parent\x8a\xea0\x12bb.worksheets.list\x90\xea0\x01\x82\xd3\xe4\x93\x02$\x12\"/v1/{parent=projects/*}/worksheets\x12\xaa\x01\n" +
- "\x14ListWorksheetFolders\x12(.bytebase.v1.ListWorksheetFoldersRequest\x1a).bytebase.v1.ListWorksheetFoldersResponse\"=\xdaA\x06parent\x90\xea0\x02\x82\xd3\xe4\x93\x02*\x12(/v1/{parent=projects/*}/worksheetFolders\x12\xa2\x01\n" +
- "\x10SearchWorksheets\x12$.bytebase.v1.SearchWorksheetsRequest\x1a%.bytebase.v1.SearchWorksheetsResponse\"A\xdaA\x06parent\x90\xea0\x02\x82\xd3\xe4\x93\x02.:\x01*\")/v1/{parent=projects/*}/worksheets:search\x12\xab\x01\n" +
- "\x0fUpdateWorksheet\x12#.bytebase.v1.UpdateWorksheetRequest\x1a\x16.bytebase.v1.Worksheet\"[\xdaA\x15worksheet,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x029:\tworksheet2,/v1/{worksheet.name=projects/*/worksheets/*}\x12\xd5\x01\n" +
- "\x18UpdateWorksheetOrganizer\x12,.bytebase.v1.UpdateWorksheetOrganizerRequest\x1a\x1f.bytebase.v1.WorksheetOrganizer\"j\xdaA\x15organizer,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x02H:\torganizer2;/v1/{organizer.worksheet=projects/*/worksheets/*}/organizer\x12\xef\x01\n" +
- "\x1dBatchUpdateWorksheetOrganizer\x121.bytebase.v1.BatchUpdateWorksheetOrganizerRequest\x1a2.bytebase.v1.BatchUpdateWorksheetOrganizerResponse\"g\xdaA\x1cparent,organizer,update_mask\x90\xea0\x02\x82\xd3\xe4\x93\x02>:\x01*\"9/v1/{parent=projects/*}/worksheets/organizers:batchUpdate\x12\x85\x01\n" +
- "\x0fDeleteWorksheet\x12#.bytebase.v1.DeleteWorksheetRequest\x1a\x16.google.protobuf.Empty\"5\xdaA\x04name\x90\xea0\x02\x82\xd3\xe4\x93\x02$*\"/v1/{name=projects/*/worksheets/*}B\xab\x01\n" +
- "\x0fcom.bytebase.v1B\x15WorksheetServiceProtoP\x01Z4github.com/bytebase/bytebase/backend/generated-go/v1\xa2\x02\x03BXX\xaa\x02\vBytebase.V1\xca\x02\vBytebase\\V1\xe2\x02\x17Bytebase\\V1\\GPBMetadata\xea\x02\fBytebase::V1b\x06proto3"
-
-var (
- file_v1_worksheet_service_proto_rawDescOnce sync.Once
- file_v1_worksheet_service_proto_rawDescData []byte
-)
-
-func file_v1_worksheet_service_proto_rawDescGZIP() []byte {
- file_v1_worksheet_service_proto_rawDescOnce.Do(func() {
- file_v1_worksheet_service_proto_rawDescData = protoimpl.X.CompressGZIP(unsafe.Slice(unsafe.StringData(file_v1_worksheet_service_proto_rawDesc), len(file_v1_worksheet_service_proto_rawDesc)))
- })
- return file_v1_worksheet_service_proto_rawDescData
-}
-
-var file_v1_worksheet_service_proto_enumTypes = make([]protoimpl.EnumInfo, 2)
-var file_v1_worksheet_service_proto_msgTypes = make([]protoimpl.MessageInfo, 16)
-var file_v1_worksheet_service_proto_goTypes = []any{
- (WorksheetFolder_Category)(0), // 0: bytebase.v1.WorksheetFolder.Category
- (Worksheet_Visibility)(0), // 1: bytebase.v1.Worksheet.Visibility
- (*CreateWorksheetRequest)(nil), // 2: bytebase.v1.CreateWorksheetRequest
- (*GetWorksheetRequest)(nil), // 3: bytebase.v1.GetWorksheetRequest
- (*ListWorksheetsRequest)(nil), // 4: bytebase.v1.ListWorksheetsRequest
- (*ListWorksheetsResponse)(nil), // 5: bytebase.v1.ListWorksheetsResponse
- (*ListWorksheetFoldersRequest)(nil), // 6: bytebase.v1.ListWorksheetFoldersRequest
- (*ListWorksheetFoldersResponse)(nil), // 7: bytebase.v1.ListWorksheetFoldersResponse
- (*WorksheetFolder)(nil), // 8: bytebase.v1.WorksheetFolder
- (*UpdateWorksheetRequest)(nil), // 9: bytebase.v1.UpdateWorksheetRequest
- (*BatchUpdateWorksheetOrganizerRequest)(nil), // 10: bytebase.v1.BatchUpdateWorksheetOrganizerRequest
- (*BatchUpdateWorksheetOrganizerResponse)(nil), // 11: bytebase.v1.BatchUpdateWorksheetOrganizerResponse
- (*UpdateWorksheetOrganizerRequest)(nil), // 12: bytebase.v1.UpdateWorksheetOrganizerRequest
- (*WorksheetOrganizer)(nil), // 13: bytebase.v1.WorksheetOrganizer
- (*DeleteWorksheetRequest)(nil), // 14: bytebase.v1.DeleteWorksheetRequest
- (*SearchWorksheetsRequest)(nil), // 15: bytebase.v1.SearchWorksheetsRequest
- (*SearchWorksheetsResponse)(nil), // 16: bytebase.v1.SearchWorksheetsResponse
- (*Worksheet)(nil), // 17: bytebase.v1.Worksheet
- (*fieldmaskpb.FieldMask)(nil), // 18: google.protobuf.FieldMask
- (*timestamppb.Timestamp)(nil), // 19: google.protobuf.Timestamp
- (*emptypb.Empty)(nil), // 20: google.protobuf.Empty
-}
-var file_v1_worksheet_service_proto_depIdxs = []int32{
- 17, // 0: bytebase.v1.CreateWorksheetRequest.worksheet:type_name -> bytebase.v1.Worksheet
- 17, // 1: bytebase.v1.ListWorksheetsResponse.worksheets:type_name -> bytebase.v1.Worksheet
- 8, // 2: bytebase.v1.ListWorksheetFoldersResponse.folders:type_name -> bytebase.v1.WorksheetFolder
- 0, // 3: bytebase.v1.WorksheetFolder.category:type_name -> bytebase.v1.WorksheetFolder.Category
- 17, // 4: bytebase.v1.UpdateWorksheetRequest.worksheet:type_name -> bytebase.v1.Worksheet
- 18, // 5: bytebase.v1.UpdateWorksheetRequest.update_mask:type_name -> google.protobuf.FieldMask
- 13, // 6: bytebase.v1.BatchUpdateWorksheetOrganizerRequest.organizer:type_name -> bytebase.v1.WorksheetOrganizer
- 18, // 7: bytebase.v1.BatchUpdateWorksheetOrganizerRequest.update_mask:type_name -> google.protobuf.FieldMask
- 13, // 8: bytebase.v1.BatchUpdateWorksheetOrganizerResponse.worksheet_organizers:type_name -> bytebase.v1.WorksheetOrganizer
- 13, // 9: bytebase.v1.UpdateWorksheetOrganizerRequest.organizer:type_name -> bytebase.v1.WorksheetOrganizer
- 18, // 10: bytebase.v1.UpdateWorksheetOrganizerRequest.update_mask:type_name -> google.protobuf.FieldMask
- 17, // 11: bytebase.v1.SearchWorksheetsResponse.worksheets:type_name -> bytebase.v1.Worksheet
- 19, // 12: bytebase.v1.Worksheet.create_time:type_name -> google.protobuf.Timestamp
- 19, // 13: bytebase.v1.Worksheet.update_time:type_name -> google.protobuf.Timestamp
- 1, // 14: bytebase.v1.Worksheet.visibility:type_name -> bytebase.v1.Worksheet.Visibility
- 2, // 15: bytebase.v1.WorksheetService.CreateWorksheet:input_type -> bytebase.v1.CreateWorksheetRequest
- 3, // 16: bytebase.v1.WorksheetService.GetWorksheet:input_type -> bytebase.v1.GetWorksheetRequest
- 4, // 17: bytebase.v1.WorksheetService.ListWorksheets:input_type -> bytebase.v1.ListWorksheetsRequest
- 6, // 18: bytebase.v1.WorksheetService.ListWorksheetFolders:input_type -> bytebase.v1.ListWorksheetFoldersRequest
- 15, // 19: bytebase.v1.WorksheetService.SearchWorksheets:input_type -> bytebase.v1.SearchWorksheetsRequest
- 9, // 20: bytebase.v1.WorksheetService.UpdateWorksheet:input_type -> bytebase.v1.UpdateWorksheetRequest
- 12, // 21: bytebase.v1.WorksheetService.UpdateWorksheetOrganizer:input_type -> bytebase.v1.UpdateWorksheetOrganizerRequest
- 10, // 22: bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer:input_type -> bytebase.v1.BatchUpdateWorksheetOrganizerRequest
- 14, // 23: bytebase.v1.WorksheetService.DeleteWorksheet:input_type -> bytebase.v1.DeleteWorksheetRequest
- 17, // 24: bytebase.v1.WorksheetService.CreateWorksheet:output_type -> bytebase.v1.Worksheet
- 17, // 25: bytebase.v1.WorksheetService.GetWorksheet:output_type -> bytebase.v1.Worksheet
- 5, // 26: bytebase.v1.WorksheetService.ListWorksheets:output_type -> bytebase.v1.ListWorksheetsResponse
- 7, // 27: bytebase.v1.WorksheetService.ListWorksheetFolders:output_type -> bytebase.v1.ListWorksheetFoldersResponse
- 16, // 28: bytebase.v1.WorksheetService.SearchWorksheets:output_type -> bytebase.v1.SearchWorksheetsResponse
- 17, // 29: bytebase.v1.WorksheetService.UpdateWorksheet:output_type -> bytebase.v1.Worksheet
- 13, // 30: bytebase.v1.WorksheetService.UpdateWorksheetOrganizer:output_type -> bytebase.v1.WorksheetOrganizer
- 11, // 31: bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer:output_type -> bytebase.v1.BatchUpdateWorksheetOrganizerResponse
- 20, // 32: bytebase.v1.WorksheetService.DeleteWorksheet:output_type -> google.protobuf.Empty
- 24, // [24:33] is the sub-list for method output_type
- 15, // [15:24] is the sub-list for method input_type
- 15, // [15:15] is the sub-list for extension type_name
- 15, // [15:15] is the sub-list for extension extendee
- 0, // [0:15] is the sub-list for field type_name
-}
-
-func init() { file_v1_worksheet_service_proto_init() }
-func file_v1_worksheet_service_proto_init() {
- if File_v1_worksheet_service_proto != nil {
- return
- }
- file_v1_annotation_proto_init()
- type x struct{}
- out := protoimpl.TypeBuilder{
- File: protoimpl.DescBuilder{
- GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
- RawDescriptor: unsafe.Slice(unsafe.StringData(file_v1_worksheet_service_proto_rawDesc), len(file_v1_worksheet_service_proto_rawDesc)),
- NumEnums: 2,
- NumMessages: 16,
- NumExtensions: 0,
- NumServices: 1,
- },
- GoTypes: file_v1_worksheet_service_proto_goTypes,
- DependencyIndexes: file_v1_worksheet_service_proto_depIdxs,
- EnumInfos: file_v1_worksheet_service_proto_enumTypes,
- MessageInfos: file_v1_worksheet_service_proto_msgTypes,
- }.Build()
- File_v1_worksheet_service_proto = out.File
- file_v1_worksheet_service_proto_goTypes = nil
- file_v1_worksheet_service_proto_depIdxs = nil
-}
diff --git a/backend/generated-go/v1/worksheet_service_grpc.pb.go b/backend/generated-go/v1/worksheet_service_grpc.pb.go
deleted file mode 100644
index 45bf87ae3f..0000000000
--- a/backend/generated-go/v1/worksheet_service_grpc.pb.go
+++ /dev/null
@@ -1,494 +0,0 @@
-// Code generated by protoc-gen-go-grpc. DO NOT EDIT.
-// versions:
-// - protoc-gen-go-grpc v1.6.2
-// - protoc (unknown)
-// source: v1/worksheet_service.proto
-
-package v1
-
-import (
- context "context"
- grpc "google.golang.org/grpc"
- codes "google.golang.org/grpc/codes"
- status "google.golang.org/grpc/status"
- emptypb "google.golang.org/protobuf/types/known/emptypb"
-)
-
-// This is a compile-time assertion to ensure that this generated file
-// is compatible with the grpc package it is being compiled against.
-// Requires gRPC-Go v1.64.0 or later.
-const _ = grpc.SupportPackageIsVersion9
-
-const (
- WorksheetService_CreateWorksheet_FullMethodName = "/bytebase.v1.WorksheetService/CreateWorksheet"
- WorksheetService_GetWorksheet_FullMethodName = "/bytebase.v1.WorksheetService/GetWorksheet"
- WorksheetService_ListWorksheets_FullMethodName = "/bytebase.v1.WorksheetService/ListWorksheets"
- WorksheetService_ListWorksheetFolders_FullMethodName = "/bytebase.v1.WorksheetService/ListWorksheetFolders"
- WorksheetService_SearchWorksheets_FullMethodName = "/bytebase.v1.WorksheetService/SearchWorksheets"
- WorksheetService_UpdateWorksheet_FullMethodName = "/bytebase.v1.WorksheetService/UpdateWorksheet"
- WorksheetService_UpdateWorksheetOrganizer_FullMethodName = "/bytebase.v1.WorksheetService/UpdateWorksheetOrganizer"
- WorksheetService_BatchUpdateWorksheetOrganizer_FullMethodName = "/bytebase.v1.WorksheetService/BatchUpdateWorksheetOrganizer"
- WorksheetService_DeleteWorksheet_FullMethodName = "/bytebase.v1.WorksheetService/DeleteWorksheet"
-)
-
-// WorksheetServiceClient is the client API for WorksheetService service.
-//
-// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
-//
-// WorksheetService manages SQL worksheets for query development.
-type WorksheetServiceClient interface {
- // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
- // Permissions required: None (authenticated users only)
- CreateWorksheet(ctx context.Context, in *CreateWorksheetRequest, opts ...grpc.CallOption) (*Worksheet, error)
- // Get a worksheet by name.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.get permission on the workspace;
- // - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- GetWorksheet(ctx context.Context, in *GetWorksheetRequest, opts ...grpc.CallOption) (*Worksheet, error)
- // List worksheets.
- // This is used for listing worksheets in a project, or across all projects by using `projects/-`.
- // Permissions required: bb.worksheets.list
- ListWorksheets(ctx context.Context, in *ListWorksheetsRequest, opts ...grpc.CallOption) (*ListWorksheetsResponse, error)
- // List the caller's worksheet folders.
- // Only folders stored in the caller's worksheet organizer are returned.
- ListWorksheetFolders(ctx context.Context, in *ListWorksheetFoldersRequest, opts ...grpc.CallOption) (*ListWorksheetFoldersResponse, error)
- // Search for worksheets.
- // This is used for finding my worksheets or worksheets shared by other people.
- // The sheet accessibility is the same as GetWorksheet().
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- SearchWorksheets(ctx context.Context, in *SearchWorksheetsRequest, opts ...grpc.CallOption) (*SearchWorksheetsResponse, error)
- // Update a worksheet.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.manage permission on the workspace;
- // - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- UpdateWorksheet(ctx context.Context, in *UpdateWorksheetRequest, opts ...grpc.CallOption) (*Worksheet, error)
- // Update the organizer of a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- UpdateWorksheetOrganizer(ctx context.Context, in *UpdateWorksheetOrganizerRequest, opts ...grpc.CallOption) (*WorksheetOrganizer, error)
- // Batch update the organizers of worksheets.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- BatchUpdateWorksheetOrganizer(ctx context.Context, in *BatchUpdateWorksheetOrganizerRequest, opts ...grpc.CallOption) (*BatchUpdateWorksheetOrganizerResponse, error)
- // Delete a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- DeleteWorksheet(ctx context.Context, in *DeleteWorksheetRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
-}
-
-type worksheetServiceClient struct {
- cc grpc.ClientConnInterface
-}
-
-func NewWorksheetServiceClient(cc grpc.ClientConnInterface) WorksheetServiceClient {
- return &worksheetServiceClient{cc}
-}
-
-func (c *worksheetServiceClient) CreateWorksheet(ctx context.Context, in *CreateWorksheetRequest, opts ...grpc.CallOption) (*Worksheet, error) {
- cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
- out := new(Worksheet)
- err := c.cc.Invoke(ctx, WorksheetService_CreateWorksheet_FullMethodName, in, out, cOpts...)
- if err != nil {
- return nil, err
- }
- return out, nil
-}
-
-func (c *worksheetServiceClient) GetWorksheet(ctx context.Context, in *GetWorksheetRequest, opts ...grpc.CallOption) (*Worksheet, error) {
- cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
- out := new(Worksheet)
- err := c.cc.Invoke(ctx, WorksheetService_GetWorksheet_FullMethodName, in, out, cOpts...)
- if err != nil {
- return nil, err
- }
- return out, nil
-}
-
-func (c *worksheetServiceClient) ListWorksheets(ctx context.Context, in *ListWorksheetsRequest, opts ...grpc.CallOption) (*ListWorksheetsResponse, error) {
- cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
- out := new(ListWorksheetsResponse)
- err := c.cc.Invoke(ctx, WorksheetService_ListWorksheets_FullMethodName, in, out, cOpts...)
- if err != nil {
- return nil, err
- }
- return out, nil
-}
-
-func (c *worksheetServiceClient) ListWorksheetFolders(ctx context.Context, in *ListWorksheetFoldersRequest, opts ...grpc.CallOption) (*ListWorksheetFoldersResponse, error) {
- cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
- out := new(ListWorksheetFoldersResponse)
- err := c.cc.Invoke(ctx, WorksheetService_ListWorksheetFolders_FullMethodName, in, out, cOpts...)
- if err != nil {
- return nil, err
- }
- return out, nil
-}
-
-func (c *worksheetServiceClient) SearchWorksheets(ctx context.Context, in *SearchWorksheetsRequest, opts ...grpc.CallOption) (*SearchWorksheetsResponse, error) {
- cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
- out := new(SearchWorksheetsResponse)
- err := c.cc.Invoke(ctx, WorksheetService_SearchWorksheets_FullMethodName, in, out, cOpts...)
- if err != nil {
- return nil, err
- }
- return out, nil
-}
-
-func (c *worksheetServiceClient) UpdateWorksheet(ctx context.Context, in *UpdateWorksheetRequest, opts ...grpc.CallOption) (*Worksheet, error) {
- cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
- out := new(Worksheet)
- err := c.cc.Invoke(ctx, WorksheetService_UpdateWorksheet_FullMethodName, in, out, cOpts...)
- if err != nil {
- return nil, err
- }
- return out, nil
-}
-
-func (c *worksheetServiceClient) UpdateWorksheetOrganizer(ctx context.Context, in *UpdateWorksheetOrganizerRequest, opts ...grpc.CallOption) (*WorksheetOrganizer, error) {
- cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
- out := new(WorksheetOrganizer)
- err := c.cc.Invoke(ctx, WorksheetService_UpdateWorksheetOrganizer_FullMethodName, in, out, cOpts...)
- if err != nil {
- return nil, err
- }
- return out, nil
-}
-
-func (c *worksheetServiceClient) BatchUpdateWorksheetOrganizer(ctx context.Context, in *BatchUpdateWorksheetOrganizerRequest, opts ...grpc.CallOption) (*BatchUpdateWorksheetOrganizerResponse, error) {
- cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
- out := new(BatchUpdateWorksheetOrganizerResponse)
- err := c.cc.Invoke(ctx, WorksheetService_BatchUpdateWorksheetOrganizer_FullMethodName, in, out, cOpts...)
- if err != nil {
- return nil, err
- }
- return out, nil
-}
-
-func (c *worksheetServiceClient) DeleteWorksheet(ctx context.Context, in *DeleteWorksheetRequest, opts ...grpc.CallOption) (*emptypb.Empty, error) {
- cOpts := append([]grpc.CallOption{grpc.StaticMethod()}, opts...)
- out := new(emptypb.Empty)
- err := c.cc.Invoke(ctx, WorksheetService_DeleteWorksheet_FullMethodName, in, out, cOpts...)
- if err != nil {
- return nil, err
- }
- return out, nil
-}
-
-// WorksheetServiceServer is the server API for WorksheetService service.
-// All implementations must embed UnimplementedWorksheetServiceServer
-// for forward compatibility.
-//
-// WorksheetService manages SQL worksheets for query development.
-type WorksheetServiceServer interface {
- // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
- // Permissions required: None (authenticated users only)
- CreateWorksheet(context.Context, *CreateWorksheetRequest) (*Worksheet, error)
- // Get a worksheet by name.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.get permission on the workspace;
- // - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- GetWorksheet(context.Context, *GetWorksheetRequest) (*Worksheet, error)
- // List worksheets.
- // This is used for listing worksheets in a project, or across all projects by using `projects/-`.
- // Permissions required: bb.worksheets.list
- ListWorksheets(context.Context, *ListWorksheetsRequest) (*ListWorksheetsResponse, error)
- // List the caller's worksheet folders.
- // Only folders stored in the caller's worksheet organizer are returned.
- ListWorksheetFolders(context.Context, *ListWorksheetFoldersRequest) (*ListWorksheetFoldersResponse, error)
- // Search for worksheets.
- // This is used for finding my worksheets or worksheets shared by other people.
- // The sheet accessibility is the same as GetWorksheet().
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- SearchWorksheets(context.Context, *SearchWorksheetsRequest) (*SearchWorksheetsResponse, error)
- // Update a worksheet.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.manage permission on the workspace;
- // - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- UpdateWorksheet(context.Context, *UpdateWorksheetRequest) (*Worksheet, error)
- // Update the organizer of a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- UpdateWorksheetOrganizer(context.Context, *UpdateWorksheetOrganizerRequest) (*WorksheetOrganizer, error)
- // Batch update the organizers of worksheets.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- BatchUpdateWorksheetOrganizer(context.Context, *BatchUpdateWorksheetOrganizerRequest) (*BatchUpdateWorksheetOrganizerResponse, error)
- // Delete a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- DeleteWorksheet(context.Context, *DeleteWorksheetRequest) (*emptypb.Empty, error)
- mustEmbedUnimplementedWorksheetServiceServer()
-}
-
-// UnimplementedWorksheetServiceServer must be embedded to have
-// forward compatible implementations.
-//
-// NOTE: this should be embedded by value instead of pointer to avoid a nil
-// pointer dereference when methods are called.
-type UnimplementedWorksheetServiceServer struct{}
-
-func (UnimplementedWorksheetServiceServer) CreateWorksheet(context.Context, *CreateWorksheetRequest) (*Worksheet, error) {
- return nil, status.Error(codes.Unimplemented, "method CreateWorksheet not implemented")
-}
-func (UnimplementedWorksheetServiceServer) GetWorksheet(context.Context, *GetWorksheetRequest) (*Worksheet, error) {
- return nil, status.Error(codes.Unimplemented, "method GetWorksheet not implemented")
-}
-func (UnimplementedWorksheetServiceServer) ListWorksheets(context.Context, *ListWorksheetsRequest) (*ListWorksheetsResponse, error) {
- return nil, status.Error(codes.Unimplemented, "method ListWorksheets not implemented")
-}
-func (UnimplementedWorksheetServiceServer) ListWorksheetFolders(context.Context, *ListWorksheetFoldersRequest) (*ListWorksheetFoldersResponse, error) {
- return nil, status.Error(codes.Unimplemented, "method ListWorksheetFolders not implemented")
-}
-func (UnimplementedWorksheetServiceServer) SearchWorksheets(context.Context, *SearchWorksheetsRequest) (*SearchWorksheetsResponse, error) {
- return nil, status.Error(codes.Unimplemented, "method SearchWorksheets not implemented")
-}
-func (UnimplementedWorksheetServiceServer) UpdateWorksheet(context.Context, *UpdateWorksheetRequest) (*Worksheet, error) {
- return nil, status.Error(codes.Unimplemented, "method UpdateWorksheet not implemented")
-}
-func (UnimplementedWorksheetServiceServer) UpdateWorksheetOrganizer(context.Context, *UpdateWorksheetOrganizerRequest) (*WorksheetOrganizer, error) {
- return nil, status.Error(codes.Unimplemented, "method UpdateWorksheetOrganizer not implemented")
-}
-func (UnimplementedWorksheetServiceServer) BatchUpdateWorksheetOrganizer(context.Context, *BatchUpdateWorksheetOrganizerRequest) (*BatchUpdateWorksheetOrganizerResponse, error) {
- return nil, status.Error(codes.Unimplemented, "method BatchUpdateWorksheetOrganizer not implemented")
-}
-func (UnimplementedWorksheetServiceServer) DeleteWorksheet(context.Context, *DeleteWorksheetRequest) (*emptypb.Empty, error) {
- return nil, status.Error(codes.Unimplemented, "method DeleteWorksheet not implemented")
-}
-func (UnimplementedWorksheetServiceServer) mustEmbedUnimplementedWorksheetServiceServer() {}
-func (UnimplementedWorksheetServiceServer) testEmbeddedByValue() {}
-
-// UnsafeWorksheetServiceServer may be embedded to opt out of forward compatibility for this service.
-// Use of this interface is not recommended, as added methods to WorksheetServiceServer will
-// result in compilation errors.
-type UnsafeWorksheetServiceServer interface {
- mustEmbedUnimplementedWorksheetServiceServer()
-}
-
-func RegisterWorksheetServiceServer(s grpc.ServiceRegistrar, srv WorksheetServiceServer) {
- // If the following call panics, it indicates UnimplementedWorksheetServiceServer was
- // embedded by pointer and is nil. This will cause panics if an
- // unimplemented method is ever invoked, so we test this at initialization
- // time to prevent it from happening at runtime later due to I/O.
- if t, ok := srv.(interface{ testEmbeddedByValue() }); ok {
- t.testEmbeddedByValue()
- }
- s.RegisterService(&WorksheetService_ServiceDesc, srv)
-}
-
-func _WorksheetService_CreateWorksheet_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
- in := new(CreateWorksheetRequest)
- if err := dec(in); err != nil {
- return nil, err
- }
- if interceptor == nil {
- return srv.(WorksheetServiceServer).CreateWorksheet(ctx, in)
- }
- info := &grpc.UnaryServerInfo{
- Server: srv,
- FullMethod: WorksheetService_CreateWorksheet_FullMethodName,
- }
- handler := func(ctx context.Context, req interface{}) (interface{}, error) {
- return srv.(WorksheetServiceServer).CreateWorksheet(ctx, req.(*CreateWorksheetRequest))
- }
- return interceptor(ctx, in, info, handler)
-}
-
-func _WorksheetService_GetWorksheet_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
- in := new(GetWorksheetRequest)
- if err := dec(in); err != nil {
- return nil, err
- }
- if interceptor == nil {
- return srv.(WorksheetServiceServer).GetWorksheet(ctx, in)
- }
- info := &grpc.UnaryServerInfo{
- Server: srv,
- FullMethod: WorksheetService_GetWorksheet_FullMethodName,
- }
- handler := func(ctx context.Context, req interface{}) (interface{}, error) {
- return srv.(WorksheetServiceServer).GetWorksheet(ctx, req.(*GetWorksheetRequest))
- }
- return interceptor(ctx, in, info, handler)
-}
-
-func _WorksheetService_ListWorksheets_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
- in := new(ListWorksheetsRequest)
- if err := dec(in); err != nil {
- return nil, err
- }
- if interceptor == nil {
- return srv.(WorksheetServiceServer).ListWorksheets(ctx, in)
- }
- info := &grpc.UnaryServerInfo{
- Server: srv,
- FullMethod: WorksheetService_ListWorksheets_FullMethodName,
- }
- handler := func(ctx context.Context, req interface{}) (interface{}, error) {
- return srv.(WorksheetServiceServer).ListWorksheets(ctx, req.(*ListWorksheetsRequest))
- }
- return interceptor(ctx, in, info, handler)
-}
-
-func _WorksheetService_ListWorksheetFolders_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
- in := new(ListWorksheetFoldersRequest)
- if err := dec(in); err != nil {
- return nil, err
- }
- if interceptor == nil {
- return srv.(WorksheetServiceServer).ListWorksheetFolders(ctx, in)
- }
- info := &grpc.UnaryServerInfo{
- Server: srv,
- FullMethod: WorksheetService_ListWorksheetFolders_FullMethodName,
- }
- handler := func(ctx context.Context, req interface{}) (interface{}, error) {
- return srv.(WorksheetServiceServer).ListWorksheetFolders(ctx, req.(*ListWorksheetFoldersRequest))
- }
- return interceptor(ctx, in, info, handler)
-}
-
-func _WorksheetService_SearchWorksheets_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
- in := new(SearchWorksheetsRequest)
- if err := dec(in); err != nil {
- return nil, err
- }
- if interceptor == nil {
- return srv.(WorksheetServiceServer).SearchWorksheets(ctx, in)
- }
- info := &grpc.UnaryServerInfo{
- Server: srv,
- FullMethod: WorksheetService_SearchWorksheets_FullMethodName,
- }
- handler := func(ctx context.Context, req interface{}) (interface{}, error) {
- return srv.(WorksheetServiceServer).SearchWorksheets(ctx, req.(*SearchWorksheetsRequest))
- }
- return interceptor(ctx, in, info, handler)
-}
-
-func _WorksheetService_UpdateWorksheet_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
- in := new(UpdateWorksheetRequest)
- if err := dec(in); err != nil {
- return nil, err
- }
- if interceptor == nil {
- return srv.(WorksheetServiceServer).UpdateWorksheet(ctx, in)
- }
- info := &grpc.UnaryServerInfo{
- Server: srv,
- FullMethod: WorksheetService_UpdateWorksheet_FullMethodName,
- }
- handler := func(ctx context.Context, req interface{}) (interface{}, error) {
- return srv.(WorksheetServiceServer).UpdateWorksheet(ctx, req.(*UpdateWorksheetRequest))
- }
- return interceptor(ctx, in, info, handler)
-}
-
-func _WorksheetService_UpdateWorksheetOrganizer_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
- in := new(UpdateWorksheetOrganizerRequest)
- if err := dec(in); err != nil {
- return nil, err
- }
- if interceptor == nil {
- return srv.(WorksheetServiceServer).UpdateWorksheetOrganizer(ctx, in)
- }
- info := &grpc.UnaryServerInfo{
- Server: srv,
- FullMethod: WorksheetService_UpdateWorksheetOrganizer_FullMethodName,
- }
- handler := func(ctx context.Context, req interface{}) (interface{}, error) {
- return srv.(WorksheetServiceServer).UpdateWorksheetOrganizer(ctx, req.(*UpdateWorksheetOrganizerRequest))
- }
- return interceptor(ctx, in, info, handler)
-}
-
-func _WorksheetService_BatchUpdateWorksheetOrganizer_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
- in := new(BatchUpdateWorksheetOrganizerRequest)
- if err := dec(in); err != nil {
- return nil, err
- }
- if interceptor == nil {
- return srv.(WorksheetServiceServer).BatchUpdateWorksheetOrganizer(ctx, in)
- }
- info := &grpc.UnaryServerInfo{
- Server: srv,
- FullMethod: WorksheetService_BatchUpdateWorksheetOrganizer_FullMethodName,
- }
- handler := func(ctx context.Context, req interface{}) (interface{}, error) {
- return srv.(WorksheetServiceServer).BatchUpdateWorksheetOrganizer(ctx, req.(*BatchUpdateWorksheetOrganizerRequest))
- }
- return interceptor(ctx, in, info, handler)
-}
-
-func _WorksheetService_DeleteWorksheet_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error, interceptor grpc.UnaryServerInterceptor) (interface{}, error) {
- in := new(DeleteWorksheetRequest)
- if err := dec(in); err != nil {
- return nil, err
- }
- if interceptor == nil {
- return srv.(WorksheetServiceServer).DeleteWorksheet(ctx, in)
- }
- info := &grpc.UnaryServerInfo{
- Server: srv,
- FullMethod: WorksheetService_DeleteWorksheet_FullMethodName,
- }
- handler := func(ctx context.Context, req interface{}) (interface{}, error) {
- return srv.(WorksheetServiceServer).DeleteWorksheet(ctx, req.(*DeleteWorksheetRequest))
- }
- return interceptor(ctx, in, info, handler)
-}
-
-// WorksheetService_ServiceDesc is the grpc.ServiceDesc for WorksheetService service.
-// It's only intended for direct use with grpc.RegisterService,
-// and not to be introspected or modified (even as a copy)
-var WorksheetService_ServiceDesc = grpc.ServiceDesc{
- ServiceName: "bytebase.v1.WorksheetService",
- HandlerType: (*WorksheetServiceServer)(nil),
- Methods: []grpc.MethodDesc{
- {
- MethodName: "CreateWorksheet",
- Handler: _WorksheetService_CreateWorksheet_Handler,
- },
- {
- MethodName: "GetWorksheet",
- Handler: _WorksheetService_GetWorksheet_Handler,
- },
- {
- MethodName: "ListWorksheets",
- Handler: _WorksheetService_ListWorksheets_Handler,
- },
- {
- MethodName: "ListWorksheetFolders",
- Handler: _WorksheetService_ListWorksheetFolders_Handler,
- },
- {
- MethodName: "SearchWorksheets",
- Handler: _WorksheetService_SearchWorksheets_Handler,
- },
- {
- MethodName: "UpdateWorksheet",
- Handler: _WorksheetService_UpdateWorksheet_Handler,
- },
- {
- MethodName: "UpdateWorksheetOrganizer",
- Handler: _WorksheetService_UpdateWorksheetOrganizer_Handler,
- },
- {
- MethodName: "BatchUpdateWorksheetOrganizer",
- Handler: _WorksheetService_BatchUpdateWorksheetOrganizer_Handler,
- },
- {
- MethodName: "DeleteWorksheet",
- Handler: _WorksheetService_DeleteWorksheet_Handler,
- },
- },
- Streams: []grpc.StreamDesc{},
- Metadata: "v1/worksheet_service.proto",
-}
diff --git a/backend/server/grpc_routes.go b/backend/server/grpc_routes.go
index a2fba1894b..b7390cbd95 100644
--- a/backend/server/grpc_routes.go
+++ b/backend/server/grpc_routes.go
@@ -121,7 +121,7 @@ func configureGrpcRouters(
userService := apiv1.NewUserService(stores, licenseService, profile, iamManager)
serviceAccountService := apiv1.NewServiceAccountService(stores, profile, iamManager)
workloadIdentityService := apiv1.NewWorkloadIdentityService(stores, profile, iamManager)
- worksheetService := apiv1.NewWorksheetService(stores, iamManager)
+ savedQueryService := apiv1.NewSavedQueryService(stores, iamManager)
workspaceService := apiv1.NewWorkspaceService(stores, iamManager, profile, licenseService, authService)
onPanic := func(_ context.Context, s connect.Spec, _ http.Header, p any) error {
@@ -183,7 +183,7 @@ func configureGrpcRouters(
add(v1connect.NewUserServiceHandler(userService, opts))
add(v1connect.NewServiceAccountServiceHandler(serviceAccountService, opts))
add(v1connect.NewWorkloadIdentityServiceHandler(workloadIdentityService, opts))
- add(v1connect.NewWorksheetServiceHandler(worksheetService, opts))
+ add(v1connect.NewSavedQueryServiceHandler(savedQueryService, opts))
add(v1connect.NewWorkspaceServiceHandler(workspaceService, opts))
return handlers
}
@@ -258,7 +258,7 @@ func configureGrpcRouters(
v1connect.SubscriptionServiceName,
v1connect.UserServiceName,
v1connect.WorkloadIdentityServiceName,
- v1connect.WorksheetServiceName,
+ v1connect.SavedQueryServiceName,
v1connect.WorkspaceServiceName,
)
reflectPath, reflectHandler := grpcreflect.NewHandlerV1(reflector)
@@ -373,7 +373,7 @@ func configureGrpcRouters(
if err := v1pb.RegisterWorkloadIdentityServiceHandler(ctx, mux, grpcConn); err != nil {
return nil, err
}
- if err := v1pb.RegisterWorksheetServiceHandler(ctx, mux, grpcConn); err != nil {
+ if err := v1pb.RegisterSavedQueryServiceHandler(ctx, mux, grpcConn); err != nil {
return nil, err
}
if err := v1pb.RegisterWorkspaceServiceHandler(ctx, mux, grpcConn); err != nil {
diff --git a/backend/store/worksheet.go b/backend/store/worksheet.go
index 8eb4f3e9f4..16b3af3caa 100644
--- a/backend/store/worksheet.go
+++ b/backend/store/worksheet.go
@@ -601,9 +601,9 @@ func GetListSheetFilter(ctx context.Context, s *Store, caller string, filter str
return user.Email, nil
}
getWorksheetID := func(name string) (string, error) {
- _, worksheetID, err := common.GetProjectIDWorksheetID(name)
+ _, worksheetID, err := common.GetProjectIDSavedQueryID(name)
if err != nil {
- return "", errors.Errorf("invalid worksheet name %q", name)
+ return "", errors.Errorf("invalid saved query name %q", name)
}
return worksheetID, nil
}
diff --git a/backend/tests/project_instance_compat_extras_test.go b/backend/tests/project_instance_compat_extras_test.go
index 8967ee97a1..09bb289847 100644
--- a/backend/tests/project_instance_compat_extras_test.go
+++ b/backend/tests/project_instance_compat_extras_test.go
@@ -98,10 +98,10 @@ func TestProjectInstanceExport(t *testing.T) {
a.Contains(err.Error(), fmt.Sprintf("instance %q not found", instanceID))
}
-// TestProjectInstanceWorksheet verifies that worksheets accept the canonical
-// project-scoped database name for databases on a project instance and reject
-// cross-project references.
-func TestProjectInstanceWorksheet(t *testing.T) {
+// TestProjectInstanceSavedQuery verifies that saved queries accept the
+// canonical project-scoped database name for databases on a project instance
+// and reject cross-project references.
+func TestProjectInstanceSavedQuery(t *testing.T) {
a := require.New(t)
ctx := context.Background()
ctl := &controller{}
@@ -111,25 +111,25 @@ func TestProjectInstanceWorksheet(t *testing.T) {
pg, err := provisionPgInstance(ctx, t)
a.NoError(err)
- const instanceID = "bot37-worksheet-instance"
- const databaseID = "bot37_worksheet_database"
+ const instanceID = "bot37-saved-query-instance"
+ const databaseID = "bot37_saved_query_database"
createPgDatabase(t, pg, databaseID)
- instance := createProjectInstanceTestInstance(ctx, t, ctl, &ctl.project.Name, instanceID, "worksheet project instance", pg)
+ instance := createProjectInstanceTestInstance(ctx, t, ctl, &ctl.project.Name, instanceID, "saved query project instance", pg)
_, err = ctl.instanceServiceClient.SyncInstance(ctx, connect.NewRequest(&v1pb.SyncInstanceRequest{Name: instance.Name}))
a.NoError(err)
databaseName := fmt.Sprintf("%s/databases/%s", instance.Name, databaseID)
_, err = ctl.databaseServiceClient.GetDatabase(ctx, connect.NewRequest(&v1pb.GetDatabaseRequest{Name: databaseName}))
a.NoError(err)
- createWorksheet := func(database string) (*v1pb.Worksheet, error) {
- resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
+ createSavedQuery := func(database string) (*v1pb.SavedQuery, error) {
+ resp, err := ctl.savedQueryServiceClient.CreateSavedQuery(ctx, connect.NewRequest(&v1pb.CreateSavedQueryRequest{
Parent: ctl.project.Name,
- Worksheet: &v1pb.Worksheet{
- Title: "project instance worksheet",
+ SavedQuery: &v1pb.SavedQuery{
+ Title: "project instance saved query",
Content: []byte("SELECT 1;"),
Database: database,
- Visibility: v1pb.Worksheet_PRIVATE,
+ Visibility: v1pb.SavedQuery_PRIVATE,
},
}))
if err != nil {
@@ -139,18 +139,18 @@ func TestProjectInstanceWorksheet(t *testing.T) {
}
// The canonical project-scoped name is accepted and retained.
- created, err := createWorksheet(databaseName)
+ created, err := createSavedQuery(databaseName)
a.NoError(err)
a.Equal(databaseName, created.Database)
- got, err := ctl.worksheetServiceClient.GetWorksheet(ctx, connect.NewRequest(&v1pb.GetWorksheetRequest{Name: created.Name}))
+ got, err := ctl.savedQueryServiceClient.GetSavedQuery(ctx, connect.NewRequest(&v1pb.GetSavedQueryRequest{Name: created.Name}))
a.NoError(err)
a.Equal(databaseName, got.Msg.Database)
// A project-instance database referenced from a different project is
// rejected with NotFound rather than leaking across projects.
- otherProject := createProjectForProjectInstanceTest(ctx, t, ctl, "bot37-worksheet-other-project")
+ otherProject := createProjectForProjectInstanceTest(ctx, t, ctl, "bot37-saved-query-other-project")
crossProjectName := fmt.Sprintf("%s/instances/%s/databases/%s", otherProject.Name, instanceID, databaseID)
- _, err = createWorksheet(crossProjectName)
+ _, err = createSavedQuery(crossProjectName)
a.Error(err)
a.Equal(connect.CodeNotFound, connect.CodeOf(err))
projectID, projectIDErr := common.GetProjectID(ctl.project.Name)
@@ -160,7 +160,7 @@ func TestProjectInstanceWorksheet(t *testing.T) {
// The workspace-form name for a project-instance database is rejected as
// non-canonical instead of resolving through the workspace alias.
workspaceFormName := fmt.Sprintf("instances/%s/databases/%s", instanceID, databaseID)
- _, err = createWorksheet(workspaceFormName)
+ _, err = createSavedQuery(workspaceFormName)
a.Error(err)
a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
a.Contains(err.Error(), fmt.Sprintf("database name %q is not canonical for its instance", workspaceFormName))
diff --git a/backend/tests/saved_query_test.go b/backend/tests/saved_query_test.go
new file mode 100644
index 0000000000..7f211dfb6b
--- /dev/null
+++ b/backend/tests/saved_query_test.go
@@ -0,0 +1,551 @@
+package tests
+
+import (
+ "context"
+ "database/sql"
+ "fmt"
+ "testing"
+
+ "connectrpc.com/connect"
+ "github.com/stretchr/testify/require"
+ "google.golang.org/protobuf/types/known/fieldmaskpb"
+
+ "github.com/bytebase/bytebase/backend/common"
+ v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
+)
+
+func TestListSavedQueries(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)
+
+ ownerToken := ctl.authInterceptor.token
+
+ otherProjectResp, err := ctl.projectServiceClient.CreateProject(ctx, connect.NewRequest(&v1pb.CreateProjectRequest{
+ Project: &v1pb.Project{
+ Title: "Saved Query Other Project",
+ AllowSelfApproval: true,
+ },
+ ProjectId: generateRandomString("saved-query-project"),
+ }))
+ a.NoError(err)
+ otherProject := otherProjectResp.Msg
+
+ otherEmail := fmt.Sprintf("saved-query-%[email protected]", generateRandomString("user"))
+ otherPassword := "1024bytebase"
+ otherUser, err := ctl.userServiceClient.CreateUser(ctx, connect.NewRequest(&v1pb.CreateUserRequest{
+ User: &v1pb.User{
+ Email: otherEmail,
+ Password: otherPassword,
+ Title: "Saved Query User",
+ },
+ }))
+ a.NoError(err)
+ _, err = ctl.addMemberToWorkspaceIAM(ctx, otherUser.Msg.Workspace, fmt.Sprintf("user:%s", otherEmail), "roles/workspaceMember")
+ a.NoError(err)
+
+ createSavedQuery := func(title, parent string) *v1pb.SavedQuery {
+ resp, err := ctl.savedQueryServiceClient.CreateSavedQuery(ctx, connect.NewRequest(&v1pb.CreateSavedQueryRequest{
+ Parent: parent,
+ SavedQuery: &v1pb.SavedQuery{
+ Title: title,
+ Content: []byte("SELECT 1;"),
+ Visibility: v1pb.SavedQuery_PROJECT_READ,
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+ }
+
+ projectOwnerSavedQuery := createSavedQuery("project-owner", ctl.project.Name)
+ crossProjectOwnerSavedQuery := createSavedQuery("cross-project-owner", otherProject.Name)
+
+ loginResp, err := ctl.authServiceClient.Login(ctx, connect.NewRequest(&v1pb.LoginRequest{
+ Email: otherEmail,
+ Password: otherPassword,
+ }))
+ a.NoError(err)
+ ctl.authInterceptor.token = loginResp.Msg.Token
+ otherSavedQuery := createSavedQuery("other-creator", ctl.project.Name)
+
+ _, err = ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ }))
+ a.Error(err)
+ a.Equal(connect.CodePermissionDenied, connect.CodeOf(err))
+
+ ctl.authInterceptor.token = ownerToken
+ roleID := generateRandomString("saved-query-lister")
+ _, err = ctl.roleServiceClient.CreateRole(ctx, connect.NewRequest(&v1pb.CreateRoleRequest{
+ Role: &v1pb.Role{
+ Title: "Saved Query Lister",
+ Permissions: []string{"bb.worksheets.list"},
+ },
+ RoleId: roleID,
+ }))
+ a.NoError(err)
+ _, err = ctl.addMemberToWorkspaceIAM(ctx, otherUser.Msg.Workspace, fmt.Sprintf("user:%s", otherEmail), fmt.Sprintf("roles/%s", roleID))
+ a.NoError(err)
+
+ ctl.authInterceptor.token = loginResp.Msg.Token
+ listProjectResp, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: fmt.Sprintf("creator == \"users/%s\"", otherEmail),
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{otherSavedQuery.Name}, savedQueryNames(listProjectResp.Msg.SavedQueries))
+
+ listNotCreatorResp, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: fmt.Sprintf("creator != \"users/%s\"", otherEmail),
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{projectOwnerSavedQuery.Name}, savedQueryNames(listNotCreatorResp.Msg.SavedQueries))
+
+ listCrossProjectResp, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: `creator == "users/[email protected]"`,
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{projectOwnerSavedQuery.Name, crossProjectOwnerSavedQuery.Name}, savedQueryNames(listCrossProjectResp.Msg.SavedQueries))
+
+ firstPageResp, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: `creator == "users/[email protected]"`,
+ PageSize: 1,
+ }))
+ a.NoError(err)
+ a.Len(firstPageResp.Msg.SavedQueries, 1)
+ a.NotEmpty(firstPageResp.Msg.NextPageToken)
+
+ secondPageResp, err := ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: `creator == "users/[email protected]"`,
+ PageSize: 1,
+ PageToken: firstPageResp.Msg.NextPageToken,
+ }))
+ a.NoError(err)
+ a.Len(secondPageResp.Msg.SavedQueries, 1)
+ a.Empty(secondPageResp.Msg.NextPageToken)
+ a.ElementsMatch(
+ []string{projectOwnerSavedQuery.Name, crossProjectOwnerSavedQuery.Name},
+ append(savedQueryNames(firstPageResp.Msg.SavedQueries), savedQueryNames(secondPageResp.Msg.SavedQueries)...),
+ )
+
+ _, err = ctl.savedQueryServiceClient.ListSavedQueries(ctx, connect.NewRequest(&v1pb.ListSavedQueriesRequest{
+ Parent: "projects/-",
+ Filter: `visibility == "PROJECT_READ"`,
+ }))
+ a.Error(err)
+ a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
+}
+
+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 {
+ resp, err := ctl.savedQueryServiceClient.CreateSavedQuery(ctx, connect.NewRequest(&v1pb.CreateSavedQueryRequest{
+ Parent: ctl.project.Name,
+ SavedQuery: &v1pb.SavedQuery{
+ Title: title,
+ Content: []byte("SELECT 1;"),
+ Visibility: v1pb.SavedQuery_PRIVATE,
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+ }
+ setFolders := func(savedQuery *v1pb.SavedQuery, folders []string) {
+ _, err := ctl.savedQueryServiceClient.UpdateSavedQueryOrganizer(ctx, connect.NewRequest(&v1pb.UpdateSavedQueryOrganizerRequest{
+ Organizer: &v1pb.SavedQueryOrganizer{
+ SavedQuery: savedQuery.Name,
+ Folders: folders,
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ }
+
+ alphaSavedQuery := createSavedQuery("alpha")
+ setFolders(alphaSavedQuery, []string{"alpha"})
+ alphaChildSavedQuery := createSavedQuery("alpha-child")
+ setFolders(alphaChildSavedQuery, []string{"alpha", "beta"})
+ alphabetSavedQuery := createSavedQuery("alphabet")
+ setFolders(alphabetSavedQuery, []string{"alphabet"})
+ nestedAlphaSavedQuery := createSavedQuery("nested-alpha")
+ setFolders(nestedAlphaSavedQuery, []string{"gamma", "alpha"})
+ rootSavedQuery := createSavedQuery("root")
+
+ resp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "alpha"`,
+ }))
+ a.NoError(err)
+ a.ElementsMatch(
+ []string{alphaSavedQuery.Name},
+ savedQueryNames(resp.Msg.SavedQueries),
+ )
+ a.NotContains(savedQueryNames(resp.Msg.SavedQueries), alphaChildSavedQuery.Name)
+ a.NotContains(savedQueryNames(resp.Msg.SavedQueries), alphabetSavedQuery.Name)
+ a.NotContains(savedQueryNames(resp.Msg.SavedQueries), nestedAlphaSavedQuery.Name)
+ a.NotContains(savedQueryNames(resp.Msg.SavedQueries), rootSavedQuery.Name)
+
+ childResp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "alpha/beta"`,
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{alphaChildSavedQuery.Name}, savedQueryNames(childResp.Msg.SavedQueries))
+
+ rootResp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == ""`,
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{rootSavedQuery.Name}, savedQueryNames(rootResp.Msg.SavedQueries))
+
+ pageFirstSavedQuery := createSavedQuery("aaa-page")
+ setFolders(pageFirstSavedQuery, []string{"paging"})
+ pageSecondSavedQuery := createSavedQuery("zzz-page")
+ setFolders(pageSecondSavedQuery, []string{"paging"})
+
+ firstPageResp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "paging"`,
+ PageSize: 1,
+ }))
+ a.NoError(err)
+ a.Equal([]string{pageFirstSavedQuery.Name}, savedQueryNames(firstPageResp.Msg.SavedQueries))
+ a.NotEmpty(firstPageResp.Msg.NextPageToken)
+
+ secondPageResp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "paging"`,
+ PageSize: 1,
+ PageToken: firstPageResp.Msg.NextPageToken,
+ }))
+ a.NoError(err)
+ a.Equal([]string{pageSecondSavedQuery.Name}, savedQueryNames(secondPageResp.Msg.SavedQueries))
+}
+
+func TestSearchSavedQueriesFilterByTitle(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 {
+ resp, err := ctl.savedQueryServiceClient.CreateSavedQuery(ctx, connect.NewRequest(&v1pb.CreateSavedQueryRequest{
+ Parent: ctl.project.Name,
+ SavedQuery: &v1pb.SavedQuery{
+ Title: title,
+ Content: []byte("SELECT 1;"),
+ Visibility: v1pb.SavedQuery_PRIVATE,
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+ }
+
+ matchedSavedQuery := createSavedQuery("Production Payroll Report")
+ unmatchedSavedQuery := createSavedQuery("Development Scratchpad")
+ percentSavedQuery := createSavedQuery("Literal 100% match")
+ underscoreSavedQuery := createSavedQuery("Literal under_score match")
+
+ resp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `title.contains("payroll")`,
+ }))
+ a.NoError(err)
+ a.Equal([]string{matchedSavedQuery.Name}, savedQueryNames(resp.Msg.SavedQueries))
+ a.NotContains(savedQueryNames(resp.Msg.SavedQueries), unmatchedSavedQuery.Name)
+
+ percentResp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `title.contains("%")`,
+ }))
+ a.NoError(err)
+ a.Equal([]string{percentSavedQuery.Name}, savedQueryNames(percentResp.Msg.SavedQueries))
+
+ underscoreResp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `title.contains("_")`,
+ }))
+ a.NoError(err)
+ a.Equal([]string{underscoreSavedQuery.Name}, savedQueryNames(underscoreResp.Msg.SavedQueries))
+
+ _, err = ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `content.contains("SELECT")`,
+ }))
+ a.Error(err)
+
+ _, err = ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `"literal".contains("x")`,
+ }))
+ a.Error(err)
+
+ _, err = ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `title.contains(name)`,
+ }))
+ a.Error(err)
+}
+
+func TestBatchUpdateSavedQueryOrganizerFilterByFolder(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 {
+ resp, err := ctl.savedQueryServiceClient.CreateSavedQuery(ctx, connect.NewRequest(&v1pb.CreateSavedQueryRequest{
+ Parent: ctl.project.Name,
+ SavedQuery: &v1pb.SavedQuery{
+ Title: title,
+ Content: []byte("SELECT 1;"),
+ Visibility: v1pb.SavedQuery_PRIVATE,
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+ }
+ setFolders := func(savedQuery *v1pb.SavedQuery, folders []string) {
+ _, err := ctl.savedQueryServiceClient.UpdateSavedQueryOrganizer(ctx, connect.NewRequest(&v1pb.UpdateSavedQueryOrganizerRequest{
+ Organizer: &v1pb.SavedQueryOrganizer{
+ SavedQuery: savedQuery.Name,
+ Folders: folders,
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ }
+ searchByFolder := func(folder string) []string {
+ resp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: fmt.Sprintf("folder == %q", folder),
+ }))
+ a.NoError(err)
+ return savedQueryNames(resp.Msg.SavedQueries)
+ }
+
+ directSavedQuery := createSavedQuery("old-direct")
+ setFolders(directSavedQuery, []string{"old"})
+ childSavedQuery := createSavedQuery("old-child")
+ setFolders(childSavedQuery, []string{"old", "child"})
+ otherSavedQuery := createSavedQuery("other")
+ setFolders(otherSavedQuery, []string{"other"})
+
+ directResp, err := ctl.savedQueryServiceClient.BatchUpdateSavedQueryOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateSavedQueryOrganizerRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "old"`,
+ Organizer: &v1pb.SavedQueryOrganizer{
+ Folders: []string{"new"},
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ a.Equal(int32(1), directResp.Msg.UpdatedCount)
+
+ childResp, err := ctl.savedQueryServiceClient.BatchUpdateSavedQueryOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateSavedQueryOrganizerRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "old/child"`,
+ Organizer: &v1pb.SavedQueryOrganizer{
+ Folders: []string{"new", "child"},
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ a.Equal(int32(1), childResp.Msg.UpdatedCount)
+
+ a.ElementsMatch([]string{directSavedQuery.Name}, searchByFolder("new"))
+ a.ElementsMatch([]string{childSavedQuery.Name}, searchByFolder("new/child"))
+ a.ElementsMatch([]string{otherSavedQuery.Name}, searchByFolder("other"))
+ a.Empty(searchByFolder("old"))
+ a.Empty(searchByFolder("old/child"))
+
+ starResp, err := ctl.savedQueryServiceClient.BatchUpdateSavedQueryOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateSavedQueryOrganizerRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "new"`,
+ Organizer: &v1pb.SavedQueryOrganizer{
+ Starred: true,
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"starred"}},
+ }))
+ a.NoError(err)
+ a.Equal(int32(1), starResp.Msg.UpdatedCount)
+ starredResp, err := ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: ctl.project.Name,
+ Filter: `folder == "new" && starred == true`,
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{directSavedQuery.Name}, savedQueryNames(starredResp.Msg.SavedQueries))
+
+ nameResp, err := ctl.savedQueryServiceClient.BatchUpdateSavedQueryOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateSavedQueryOrganizerRequest{
+ Parent: ctl.project.Name,
+ Filter: fmt.Sprintf(`name in [%q,%q]`, directSavedQuery.Name, childSavedQuery.Name),
+ Organizer: &v1pb.SavedQueryOrganizer{
+ Folders: []string{"selected"},
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ a.Equal(int32(2), nameResp.Msg.UpdatedCount)
+ a.ElementsMatch([]string{directSavedQuery.Name, childSavedQuery.Name}, searchByFolder("selected"))
+ a.ElementsMatch([]string{otherSavedQuery.Name}, searchByFolder("other"))
+}
+
+func TestListSavedQueryFoldersReturnsCallerFolders(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)
+
+ ownerToken := ctl.authInterceptor.token
+
+ createSavedQuery := func(title string, visibility v1pb.SavedQuery_Visibility) *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;"),
+ Visibility: visibility,
+ },
+ }))
+ a.NoError(err)
+ return resp.Msg
+ }
+ setFolders := func(savedQuery *v1pb.SavedQuery, folders []string) {
+ _, err := ctl.savedQueryServiceClient.UpdateSavedQueryOrganizer(ctx, connect.NewRequest(&v1pb.UpdateSavedQueryOrganizerRequest{
+ Organizer: &v1pb.SavedQueryOrganizer{
+ SavedQuery: savedQuery.Name,
+ Folders: folders,
+ },
+ UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
+ }))
+ a.NoError(err)
+ }
+
+ ownerSavedQuery := createSavedQuery("owner", v1pb.SavedQuery_PRIVATE)
+ setFolders(ownerSavedQuery, []string{"owner", "child"})
+ ownerSharedSavedQuery := createSavedQuery("owner-shared", v1pb.SavedQuery_PROJECT_READ)
+ setFolders(ownerSharedSavedQuery, []string{"owner-shared"})
+
+ otherEmail := fmt.Sprintf("saved-query-folder-%[email protected]", generateRandomString("user"))
+ otherPassword := "1024bytebase"
+ otherUser, err := ctl.userServiceClient.CreateUser(ctx, connect.NewRequest(&v1pb.CreateUserRequest{
+ User: &v1pb.User{
+ Email: otherEmail,
+ Password: otherPassword,
+ Title: "Saved Query Folder User",
+ },
+ }))
+ a.NoError(err)
+ _, err = ctl.addMemberToWorkspaceIAM(ctx, otherUser.Msg.Workspace, fmt.Sprintf("user:%s", otherEmail), "roles/workspaceMember")
+ a.NoError(err)
+ policyResp, err := ctl.projectServiceClient.GetIamPolicy(ctx, connect.NewRequest(&v1pb.GetIamPolicyRequest{
+ Resource: ctl.project.Name,
+ }))
+ a.NoError(err)
+ policy := policyResp.Msg
+ policy.Bindings = append(policy.Bindings, &v1pb.Binding{
+ Role: "roles/sqlEditorUser",
+ Members: []string{fmt.Sprintf("user:%s", otherEmail)},
+ })
+ _, err = ctl.projectServiceClient.SetIamPolicy(ctx, connect.NewRequest(&v1pb.SetIamPolicyRequest{
+ Resource: ctl.project.Name,
+ Policy: policy,
+ }))
+ a.NoError(err)
+
+ loginResp, err := ctl.authServiceClient.Login(ctx, connect.NewRequest(&v1pb.LoginRequest{
+ Email: otherEmail,
+ Password: otherPassword,
+ }))
+ a.NoError(err)
+ ctl.authInterceptor.token = loginResp.Msg.Token
+ sharedSavedQuery := createSavedQuery("shared", v1pb.SavedQuery_PROJECT_READ)
+ setFolders(sharedSavedQuery, []string{"other", "shared"})
+ privateSavedQuery := createSavedQuery("private", v1pb.SavedQuery_PRIVATE)
+
+ ctl.authInterceptor.token = ownerToken
+ setFolders(sharedSavedQuery, []string{"owner", "child"})
+
+ db, err := sql.Open("pgx", ctl.profile.PgURL)
+ a.NoError(err)
+ defer db.Close()
+ _, privateSavedQueryID, err := common.GetProjectIDSavedQueryID(privateSavedQuery.Name)
+ a.NoError(err)
+ _, err = db.ExecContext(ctx, `
+ INSERT INTO worksheet_organizer (worksheet, principal, payload)
+ SELECT resource_id, $1, '{"folders":["private"]}'::jsonb
+ FROM worksheet
+ WHERE resource_id = $2
+ `, "[email protected]", privateSavedQueryID)
+ a.NoError(err)
+
+ resp, err := ctl.savedQueryServiceClient.ListSavedQueryFolders(ctx, connect.NewRequest(&v1pb.ListSavedQueryFoldersRequest{
+ Parent: ctl.project.Name,
+ }))
+ a.NoError(err)
+ a.ElementsMatch([]string{
+ "MINE:[owner]",
+ "MINE:[owner child]",
+ "MINE:[owner-shared]",
+ "SHARED:[owner]",
+ "SHARED:[owner child]",
+ "SHARED:[private]",
+ }, savedQueryFolderEntries(resp.Msg.Folders))
+}
+
+func TestSearchSavedQueriesRejectsWildcardProject(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)
+
+ _, err = ctl.savedQueryServiceClient.SearchSavedQueries(ctx, connect.NewRequest(&v1pb.SearchSavedQueriesRequest{
+ Parent: "projects/-",
+ }))
+ a.Error(err)
+ a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
+}
+
+func savedQueryNames(savedQueries []*v1pb.SavedQuery) []string {
+ names := make([]string, 0, len(savedQueries))
+ for _, savedQuery := range savedQueries {
+ names = append(names, savedQuery.Name)
+ }
+ return names
+}
+
+func savedQueryFolderEntries(folders []*v1pb.SavedQueryFolder) []string {
+ entries := make([]string, 0, len(folders))
+ for _, folder := range folders {
+ entries = append(entries, fmt.Sprintf("%s:%v", folder.Category, folder.Folders))
+ }
+ return entries
+}
diff --git a/backend/tests/tests.go b/backend/tests/tests.go
index 546edaee5d..85b2720db9 100644
--- a/backend/tests/tests.go
+++ b/backend/tests/tests.go
@@ -102,7 +102,7 @@ type controller struct {
databaseServiceClient v1connect.DatabaseServiceClient
databaseCatalogServiceClient v1connect.DatabaseCatalogServiceClient
sheetServiceClient v1connect.SheetServiceClient
- worksheetServiceClient v1connect.WorksheetServiceClient
+ savedQueryServiceClient v1connect.SavedQueryServiceClient
sqlServiceClient v1connect.SQLServiceClient
queryHistoryServiceClient v1connect.QueryHistoryServiceClient
subscriptionServiceClient v1connect.SubscriptionServiceClient
@@ -296,7 +296,7 @@ func (ctl *controller) start(ctx context.Context, port int) (context.Context, er
ctl.databaseServiceClient = v1connect.NewDatabaseServiceClient(ctl.client, baseURL, interceptors)
ctl.databaseCatalogServiceClient = v1connect.NewDatabaseCatalogServiceClient(ctl.client, baseURL, interceptors)
ctl.sheetServiceClient = v1connect.NewSheetServiceClient(ctl.client, baseURL, interceptors)
- ctl.worksheetServiceClient = v1connect.NewWorksheetServiceClient(ctl.client, baseURL, interceptors)
+ ctl.savedQueryServiceClient = v1connect.NewSavedQueryServiceClient(ctl.client, baseURL, interceptors)
ctl.sqlServiceClient = v1connect.NewSQLServiceClient(ctl.client, baseURL, interceptors)
ctl.queryHistoryServiceClient = v1connect.NewQueryHistoryServiceClient(ctl.client, baseURL, interceptors)
ctl.subscriptionServiceClient = v1connect.NewSubscriptionServiceClient(ctl.client, baseURL, interceptors)
diff --git a/backend/tests/worksheet_test.go b/backend/tests/worksheet_test.go
deleted file mode 100644
index fa2e255f5d..0000000000
--- a/backend/tests/worksheet_test.go
+++ /dev/null
@@ -1,551 +0,0 @@
-package tests
-
-import (
- "context"
- "database/sql"
- "fmt"
- "testing"
-
- "connectrpc.com/connect"
- "github.com/stretchr/testify/require"
- "google.golang.org/protobuf/types/known/fieldmaskpb"
-
- "github.com/bytebase/bytebase/backend/common"
- v1pb "github.com/bytebase/bytebase/backend/generated-go/v1"
-)
-
-func TestListWorksheets(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)
-
- ownerToken := ctl.authInterceptor.token
-
- otherProjectResp, err := ctl.projectServiceClient.CreateProject(ctx, connect.NewRequest(&v1pb.CreateProjectRequest{
- Project: &v1pb.Project{
- Title: "Worksheet Other Project",
- AllowSelfApproval: true,
- },
- ProjectId: generateRandomString("worksheet-project"),
- }))
- a.NoError(err)
- otherProject := otherProjectResp.Msg
-
- otherEmail := fmt.Sprintf("worksheet-%[email protected]", generateRandomString("user"))
- otherPassword := "1024bytebase"
- otherUser, err := ctl.userServiceClient.CreateUser(ctx, connect.NewRequest(&v1pb.CreateUserRequest{
- User: &v1pb.User{
- Email: otherEmail,
- Password: otherPassword,
- Title: "Worksheet User",
- },
- }))
- a.NoError(err)
- _, err = ctl.addMemberToWorkspaceIAM(ctx, otherUser.Msg.Workspace, fmt.Sprintf("user:%s", otherEmail), "roles/workspaceMember")
- a.NoError(err)
-
- createWorksheet := func(title, parent string) *v1pb.Worksheet {
- resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
- Parent: parent,
- Worksheet: &v1pb.Worksheet{
- Title: title,
- Content: []byte("SELECT 1;"),
- Visibility: v1pb.Worksheet_PROJECT_READ,
- },
- }))
- a.NoError(err)
- return resp.Msg
- }
-
- projectOwnerWorksheet := createWorksheet("project-owner", ctl.project.Name)
- crossProjectOwnerWorksheet := createWorksheet("cross-project-owner", otherProject.Name)
-
- loginResp, err := ctl.authServiceClient.Login(ctx, connect.NewRequest(&v1pb.LoginRequest{
- Email: otherEmail,
- Password: otherPassword,
- }))
- a.NoError(err)
- ctl.authInterceptor.token = loginResp.Msg.Token
- otherWorksheet := createWorksheet("other-creator", ctl.project.Name)
-
- _, err = ctl.worksheetServiceClient.ListWorksheets(ctx, connect.NewRequest(&v1pb.ListWorksheetsRequest{
- Parent: "projects/-",
- }))
- a.Error(err)
- a.Equal(connect.CodePermissionDenied, connect.CodeOf(err))
-
- ctl.authInterceptor.token = ownerToken
- roleID := generateRandomString("worksheet-lister")
- _, err = ctl.roleServiceClient.CreateRole(ctx, connect.NewRequest(&v1pb.CreateRoleRequest{
- Role: &v1pb.Role{
- Title: "Worksheet Lister",
- Permissions: []string{"bb.worksheets.list"},
- },
- RoleId: roleID,
- }))
- a.NoError(err)
- _, err = ctl.addMemberToWorkspaceIAM(ctx, otherUser.Msg.Workspace, fmt.Sprintf("user:%s", otherEmail), fmt.Sprintf("roles/%s", roleID))
- a.NoError(err)
-
- ctl.authInterceptor.token = loginResp.Msg.Token
- listProjectResp, err := ctl.worksheetServiceClient.ListWorksheets(ctx, connect.NewRequest(&v1pb.ListWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: fmt.Sprintf("creator == \"users/%s\"", otherEmail),
- }))
- a.NoError(err)
- a.ElementsMatch([]string{otherWorksheet.Name}, worksheetNames(listProjectResp.Msg.Worksheets))
-
- listNotCreatorResp, err := ctl.worksheetServiceClient.ListWorksheets(ctx, connect.NewRequest(&v1pb.ListWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: fmt.Sprintf("creator != \"users/%s\"", otherEmail),
- }))
- a.NoError(err)
- a.ElementsMatch([]string{projectOwnerWorksheet.Name}, worksheetNames(listNotCreatorResp.Msg.Worksheets))
-
- listCrossProjectResp, err := ctl.worksheetServiceClient.ListWorksheets(ctx, connect.NewRequest(&v1pb.ListWorksheetsRequest{
- Parent: "projects/-",
- Filter: `creator == "users/[email protected]"`,
- }))
- a.NoError(err)
- a.ElementsMatch([]string{projectOwnerWorksheet.Name, crossProjectOwnerWorksheet.Name}, worksheetNames(listCrossProjectResp.Msg.Worksheets))
-
- firstPageResp, err := ctl.worksheetServiceClient.ListWorksheets(ctx, connect.NewRequest(&v1pb.ListWorksheetsRequest{
- Parent: "projects/-",
- Filter: `creator == "users/[email protected]"`,
- PageSize: 1,
- }))
- a.NoError(err)
- a.Len(firstPageResp.Msg.Worksheets, 1)
- a.NotEmpty(firstPageResp.Msg.NextPageToken)
-
- secondPageResp, err := ctl.worksheetServiceClient.ListWorksheets(ctx, connect.NewRequest(&v1pb.ListWorksheetsRequest{
- Parent: "projects/-",
- Filter: `creator == "users/[email protected]"`,
- PageSize: 1,
- PageToken: firstPageResp.Msg.NextPageToken,
- }))
- a.NoError(err)
- a.Len(secondPageResp.Msg.Worksheets, 1)
- a.Empty(secondPageResp.Msg.NextPageToken)
- a.ElementsMatch(
- []string{projectOwnerWorksheet.Name, crossProjectOwnerWorksheet.Name},
- append(worksheetNames(firstPageResp.Msg.Worksheets), worksheetNames(secondPageResp.Msg.Worksheets)...),
- )
-
- _, err = ctl.worksheetServiceClient.ListWorksheets(ctx, connect.NewRequest(&v1pb.ListWorksheetsRequest{
- Parent: "projects/-",
- Filter: `visibility == "PROJECT_READ"`,
- }))
- a.Error(err)
- a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
-}
-
-func TestSearchWorksheetsFilterByFolder(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)
-
- createWorksheet := func(title string) *v1pb.Worksheet {
- resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
- Parent: ctl.project.Name,
- Worksheet: &v1pb.Worksheet{
- Title: title,
- Content: []byte("SELECT 1;"),
- Visibility: v1pb.Worksheet_PRIVATE,
- },
- }))
- a.NoError(err)
- return resp.Msg
- }
- setFolders := func(worksheet *v1pb.Worksheet, folders []string) {
- _, err := ctl.worksheetServiceClient.UpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.UpdateWorksheetOrganizerRequest{
- Organizer: &v1pb.WorksheetOrganizer{
- Worksheet: worksheet.Name,
- Folders: folders,
- },
- UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
- }))
- a.NoError(err)
- }
-
- alphaWorksheet := createWorksheet("alpha")
- setFolders(alphaWorksheet, []string{"alpha"})
- alphaChildWorksheet := createWorksheet("alpha-child")
- setFolders(alphaChildWorksheet, []string{"alpha", "beta"})
- alphabetWorksheet := createWorksheet("alphabet")
- setFolders(alphabetWorksheet, []string{"alphabet"})
- nestedAlphaWorksheet := createWorksheet("nested-alpha")
- setFolders(nestedAlphaWorksheet, []string{"gamma", "alpha"})
- rootWorksheet := createWorksheet("root")
-
- resp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `folder == "alpha"`,
- }))
- a.NoError(err)
- a.ElementsMatch(
- []string{alphaWorksheet.Name},
- worksheetNames(resp.Msg.Worksheets),
- )
- a.NotContains(worksheetNames(resp.Msg.Worksheets), alphaChildWorksheet.Name)
- a.NotContains(worksheetNames(resp.Msg.Worksheets), alphabetWorksheet.Name)
- a.NotContains(worksheetNames(resp.Msg.Worksheets), nestedAlphaWorksheet.Name)
- a.NotContains(worksheetNames(resp.Msg.Worksheets), rootWorksheet.Name)
-
- childResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `folder == "alpha/beta"`,
- }))
- a.NoError(err)
- a.ElementsMatch([]string{alphaChildWorksheet.Name}, worksheetNames(childResp.Msg.Worksheets))
-
- rootResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `folder == ""`,
- }))
- a.NoError(err)
- a.ElementsMatch([]string{rootWorksheet.Name}, worksheetNames(rootResp.Msg.Worksheets))
-
- pageFirstWorksheet := createWorksheet("aaa-page")
- setFolders(pageFirstWorksheet, []string{"paging"})
- pageSecondWorksheet := createWorksheet("zzz-page")
- setFolders(pageSecondWorksheet, []string{"paging"})
-
- firstPageResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `folder == "paging"`,
- PageSize: 1,
- }))
- a.NoError(err)
- a.Equal([]string{pageFirstWorksheet.Name}, worksheetNames(firstPageResp.Msg.Worksheets))
- a.NotEmpty(firstPageResp.Msg.NextPageToken)
-
- secondPageResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `folder == "paging"`,
- PageSize: 1,
- PageToken: firstPageResp.Msg.NextPageToken,
- }))
- a.NoError(err)
- a.Equal([]string{pageSecondWorksheet.Name}, worksheetNames(secondPageResp.Msg.Worksheets))
-}
-
-func TestSearchWorksheetsFilterByTitle(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)
-
- createWorksheet := func(title string) *v1pb.Worksheet {
- resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
- Parent: ctl.project.Name,
- Worksheet: &v1pb.Worksheet{
- Title: title,
- Content: []byte("SELECT 1;"),
- Visibility: v1pb.Worksheet_PRIVATE,
- },
- }))
- a.NoError(err)
- return resp.Msg
- }
-
- matchedWorksheet := createWorksheet("Production Payroll Report")
- unmatchedWorksheet := createWorksheet("Development Scratchpad")
- percentWorksheet := createWorksheet("Literal 100% match")
- underscoreWorksheet := createWorksheet("Literal under_score match")
-
- resp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `title.contains("payroll")`,
- }))
- a.NoError(err)
- a.Equal([]string{matchedWorksheet.Name}, worksheetNames(resp.Msg.Worksheets))
- a.NotContains(worksheetNames(resp.Msg.Worksheets), unmatchedWorksheet.Name)
-
- percentResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `title.contains("%")`,
- }))
- a.NoError(err)
- a.Equal([]string{percentWorksheet.Name}, worksheetNames(percentResp.Msg.Worksheets))
-
- underscoreResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `title.contains("_")`,
- }))
- a.NoError(err)
- a.Equal([]string{underscoreWorksheet.Name}, worksheetNames(underscoreResp.Msg.Worksheets))
-
- _, err = ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `content.contains("SELECT")`,
- }))
- a.Error(err)
-
- _, err = ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `"literal".contains("x")`,
- }))
- a.Error(err)
-
- _, err = ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `title.contains(name)`,
- }))
- a.Error(err)
-}
-
-func TestBatchUpdateWorksheetOrganizerFilterByFolder(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)
-
- createWorksheet := func(title string) *v1pb.Worksheet {
- resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
- Parent: ctl.project.Name,
- Worksheet: &v1pb.Worksheet{
- Title: title,
- Content: []byte("SELECT 1;"),
- Visibility: v1pb.Worksheet_PRIVATE,
- },
- }))
- a.NoError(err)
- return resp.Msg
- }
- setFolders := func(worksheet *v1pb.Worksheet, folders []string) {
- _, err := ctl.worksheetServiceClient.UpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.UpdateWorksheetOrganizerRequest{
- Organizer: &v1pb.WorksheetOrganizer{
- Worksheet: worksheet.Name,
- Folders: folders,
- },
- UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
- }))
- a.NoError(err)
- }
- searchByFolder := func(folder string) []string {
- resp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: fmt.Sprintf("folder == %q", folder),
- }))
- a.NoError(err)
- return worksheetNames(resp.Msg.Worksheets)
- }
-
- directWorksheet := createWorksheet("old-direct")
- setFolders(directWorksheet, []string{"old"})
- childWorksheet := createWorksheet("old-child")
- setFolders(childWorksheet, []string{"old", "child"})
- otherWorksheet := createWorksheet("other")
- setFolders(otherWorksheet, []string{"other"})
-
- directResp, err := ctl.worksheetServiceClient.BatchUpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateWorksheetOrganizerRequest{
- Parent: ctl.project.Name,
- Filter: `folder == "old"`,
- Organizer: &v1pb.WorksheetOrganizer{
- Folders: []string{"new"},
- },
- UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
- }))
- a.NoError(err)
- a.Equal(int32(1), directResp.Msg.UpdatedCount)
-
- childResp, err := ctl.worksheetServiceClient.BatchUpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateWorksheetOrganizerRequest{
- Parent: ctl.project.Name,
- Filter: `folder == "old/child"`,
- Organizer: &v1pb.WorksheetOrganizer{
- Folders: []string{"new", "child"},
- },
- UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
- }))
- a.NoError(err)
- a.Equal(int32(1), childResp.Msg.UpdatedCount)
-
- a.ElementsMatch([]string{directWorksheet.Name}, searchByFolder("new"))
- a.ElementsMatch([]string{childWorksheet.Name}, searchByFolder("new/child"))
- a.ElementsMatch([]string{otherWorksheet.Name}, searchByFolder("other"))
- a.Empty(searchByFolder("old"))
- a.Empty(searchByFolder("old/child"))
-
- starResp, err := ctl.worksheetServiceClient.BatchUpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateWorksheetOrganizerRequest{
- Parent: ctl.project.Name,
- Filter: `folder == "new"`,
- Organizer: &v1pb.WorksheetOrganizer{
- Starred: true,
- },
- UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"starred"}},
- }))
- a.NoError(err)
- a.Equal(int32(1), starResp.Msg.UpdatedCount)
- starredResp, err := ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: ctl.project.Name,
- Filter: `folder == "new" && starred == true`,
- }))
- a.NoError(err)
- a.ElementsMatch([]string{directWorksheet.Name}, worksheetNames(starredResp.Msg.Worksheets))
-
- nameResp, err := ctl.worksheetServiceClient.BatchUpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.BatchUpdateWorksheetOrganizerRequest{
- Parent: ctl.project.Name,
- Filter: fmt.Sprintf(`name in [%q,%q]`, directWorksheet.Name, childWorksheet.Name),
- Organizer: &v1pb.WorksheetOrganizer{
- Folders: []string{"selected"},
- },
- UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
- }))
- a.NoError(err)
- a.Equal(int32(2), nameResp.Msg.UpdatedCount)
- a.ElementsMatch([]string{directWorksheet.Name, childWorksheet.Name}, searchByFolder("selected"))
- a.ElementsMatch([]string{otherWorksheet.Name}, searchByFolder("other"))
-}
-
-func TestListWorksheetFoldersReturnsCallerFolders(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)
-
- ownerToken := ctl.authInterceptor.token
-
- createWorksheet := func(title string, visibility v1pb.Worksheet_Visibility) *v1pb.Worksheet {
- resp, err := ctl.worksheetServiceClient.CreateWorksheet(ctx, connect.NewRequest(&v1pb.CreateWorksheetRequest{
- Parent: ctl.project.Name,
- Worksheet: &v1pb.Worksheet{
- Title: title,
- Content: []byte("SELECT 1;"),
- Visibility: visibility,
- },
- }))
- a.NoError(err)
- return resp.Msg
- }
- setFolders := func(worksheet *v1pb.Worksheet, folders []string) {
- _, err := ctl.worksheetServiceClient.UpdateWorksheetOrganizer(ctx, connect.NewRequest(&v1pb.UpdateWorksheetOrganizerRequest{
- Organizer: &v1pb.WorksheetOrganizer{
- Worksheet: worksheet.Name,
- Folders: folders,
- },
- UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"folders"}},
- }))
- a.NoError(err)
- }
-
- ownerWorksheet := createWorksheet("owner", v1pb.Worksheet_PRIVATE)
- setFolders(ownerWorksheet, []string{"owner", "child"})
- ownerSharedWorksheet := createWorksheet("owner-shared", v1pb.Worksheet_PROJECT_READ)
- setFolders(ownerSharedWorksheet, []string{"owner-shared"})
-
- otherEmail := fmt.Sprintf("worksheet-folder-%[email protected]", generateRandomString("user"))
- otherPassword := "1024bytebase"
- otherUser, err := ctl.userServiceClient.CreateUser(ctx, connect.NewRequest(&v1pb.CreateUserRequest{
- User: &v1pb.User{
- Email: otherEmail,
- Password: otherPassword,
- Title: "Worksheet Folder User",
- },
- }))
- a.NoError(err)
- _, err = ctl.addMemberToWorkspaceIAM(ctx, otherUser.Msg.Workspace, fmt.Sprintf("user:%s", otherEmail), "roles/workspaceMember")
- a.NoError(err)
- policyResp, err := ctl.projectServiceClient.GetIamPolicy(ctx, connect.NewRequest(&v1pb.GetIamPolicyRequest{
- Resource: ctl.project.Name,
- }))
- a.NoError(err)
- policy := policyResp.Msg
- policy.Bindings = append(policy.Bindings, &v1pb.Binding{
- Role: "roles/sqlEditorUser",
- Members: []string{fmt.Sprintf("user:%s", otherEmail)},
- })
- _, err = ctl.projectServiceClient.SetIamPolicy(ctx, connect.NewRequest(&v1pb.SetIamPolicyRequest{
- Resource: ctl.project.Name,
- Policy: policy,
- }))
- a.NoError(err)
-
- loginResp, err := ctl.authServiceClient.Login(ctx, connect.NewRequest(&v1pb.LoginRequest{
- Email: otherEmail,
- Password: otherPassword,
- }))
- a.NoError(err)
- ctl.authInterceptor.token = loginResp.Msg.Token
- sharedWorksheet := createWorksheet("shared", v1pb.Worksheet_PROJECT_READ)
- setFolders(sharedWorksheet, []string{"other", "shared"})
- privateWorksheet := createWorksheet("private", v1pb.Worksheet_PRIVATE)
-
- ctl.authInterceptor.token = ownerToken
- setFolders(sharedWorksheet, []string{"owner", "child"})
-
- db, err := sql.Open("pgx", ctl.profile.PgURL)
- a.NoError(err)
- defer db.Close()
- _, privateWorksheetID, err := common.GetProjectIDWorksheetID(privateWorksheet.Name)
- a.NoError(err)
- _, err = db.ExecContext(ctx, `
- INSERT INTO worksheet_organizer (worksheet, principal, payload)
- SELECT resource_id, $1, '{"folders":["private"]}'::jsonb
- FROM worksheet
- WHERE resource_id = $2
- `, "[email protected]", privateWorksheetID)
- a.NoError(err)
-
- resp, err := ctl.worksheetServiceClient.ListWorksheetFolders(ctx, connect.NewRequest(&v1pb.ListWorksheetFoldersRequest{
- Parent: ctl.project.Name,
- }))
- a.NoError(err)
- a.ElementsMatch([]string{
- "MINE:[owner]",
- "MINE:[owner child]",
- "MINE:[owner-shared]",
- "SHARED:[owner]",
- "SHARED:[owner child]",
- "SHARED:[private]",
- }, worksheetFolderEntries(resp.Msg.Folders))
-}
-
-func TestSearchWorksheetsRejectsWildcardProject(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)
-
- _, err = ctl.worksheetServiceClient.SearchWorksheets(ctx, connect.NewRequest(&v1pb.SearchWorksheetsRequest{
- Parent: "projects/-",
- }))
- a.Error(err)
- a.Equal(connect.CodeInvalidArgument, connect.CodeOf(err))
-}
-
-func worksheetNames(worksheets []*v1pb.Worksheet) []string {
- names := make([]string, 0, len(worksheets))
- for _, worksheet := range worksheets {
- names = append(names, worksheet.Name)
- }
- return names
-}
-
-func worksheetFolderEntries(folders []*v1pb.WorksheetFolder) []string {
- entries := make([]string, 0, len(folders))
- for _, folder := range folders {
- entries = append(entries, fmt.Sprintf("%s:%v", folder.Category, folder.Folders))
- }
- return entries
-}
diff --git a/frontend/src/api/index.ts b/frontend/src/api/index.ts
index f3051164cc..e8ce86cb36 100644
--- a/frontend/src/api/index.ts
+++ b/frontend/src/api/index.ts
@@ -31,7 +31,7 @@ import { SubscriptionService } from "@/types/proto-es/v1/subscription_service_pb
import { ServiceAccountService } from "@/types/proto-es/v1/service_account_service_pb";
import { UserService } from "@/types/proto-es/v1/user_service_pb";
import { WorkloadIdentityService } from "@/types/proto-es/v1/workload_identity_service_pb";
-import { WorksheetService } from "@/types/proto-es/v1/worksheet_service_pb";
+import { SavedQueryService } from "@/types/proto-es/v1/saved_query_service_pb";
import { WorkspaceService } from "@/types/proto-es/v1/workspace_service_pb";
import {
authInterceptor,
@@ -159,8 +159,8 @@ export const releaseServiceClientConnect = createClient(
transport
);
-export const worksheetServiceClientConnect = createClient(
- WorksheetService,
+export const savedQueryServiceClientConnect = createClient(
+ SavedQueryService,
transport
);
diff --git a/frontend/src/api/methods.ts b/frontend/src/api/methods.ts
index 3800fcf8b7..84f79ee661 100644
--- a/frontend/src/api/methods.ts
+++ b/frontend/src/api/methods.ts
@@ -20,6 +20,7 @@ import { ReviewConfigService } from "@/types/proto-es/v1/review_config_service_p
import { RevisionService } from "@/types/proto-es/v1/revision_service_pb";
import { RoleService } from "@/types/proto-es/v1/role_service_pb";
import { RolloutService } from "@/types/proto-es/v1/rollout_service_pb";
+import { SavedQueryService } from "@/types/proto-es/v1/saved_query_service_pb";
import { ServiceAccountService } from "@/types/proto-es/v1/service_account_service_pb";
import { SettingService } from "@/types/proto-es/v1/setting_service_pb";
import { SheetService } from "@/types/proto-es/v1/sheet_service_pb";
@@ -27,7 +28,6 @@ import { SQLService } from "@/types/proto-es/v1/sql_service_pb";
import { SubscriptionService } from "@/types/proto-es/v1/subscription_service_pb";
import { UserService } from "@/types/proto-es/v1/user_service_pb";
import { WorkloadIdentityService } from "@/types/proto-es/v1/workload_identity_service_pb";
-import { WorksheetService } from "@/types/proto-es/v1/worksheet_service_pb";
import { WorkspaceService } from "@/types/proto-es/v1/workspace_service_pb";
// The methods that have audit field in their options.
@@ -60,7 +60,7 @@ export const ALL_METHODS_WITH_AUDIT = [
SubscriptionService,
UserService,
WorkloadIdentityService,
- WorksheetService,
+ SavedQueryService,
WorkspaceService,
]
.reduce((list, service) => {
diff --git a/frontend/src/app/router/handles.ts b/frontend/src/app/router/handles.ts
index ed54062bae..1ff891f11a 100644
--- a/frontend/src/app/router/handles.ts
+++ b/frontend/src/app/router/handles.ts
@@ -56,7 +56,7 @@ export const SQL_EDITOR_HOME_MODULE = "sql-editor.home";
export const SQL_EDITOR_PROJECT_MODULE = "sql-editor.project";
export const SQL_EDITOR_INSTANCE_MODULE = "sql-editor.instance";
export const SQL_EDITOR_DATABASE_MODULE = "sql-editor.database";
-export const SQL_EDITOR_WORKSHEET_MODULE = "sql-editor.worksheet";
+export const SQL_EDITOR_SAVED_QUERY_MODULE = "sql-editor.saved-query";
export const SQL_EDITOR_QUERY_HISTORY_MODULE = "sql-editor.query-history";
// --- dashboard/workspaceSetting.ts ---
diff --git a/frontend/src/app/router/routes/sqlEditor.tsx b/frontend/src/app/router/routes/sqlEditor.tsx
index 57f6cfcb19..aec8aa3cde 100644
--- a/frontend/src/app/router/routes/sqlEditor.tsx
+++ b/frontend/src/app/router/routes/sqlEditor.tsx
@@ -6,7 +6,7 @@ import {
SQL_EDITOR_INSTANCE_MODULE,
SQL_EDITOR_PROJECT_MODULE,
SQL_EDITOR_QUERY_HISTORY_MODULE,
- SQL_EDITOR_WORKSHEET_MODULE,
+ SQL_EDITOR_SAVED_QUERY_MODULE,
} from "@/app/router/handles";
import type { Permission } from "@/types";
@@ -68,8 +68,8 @@ export const sqlEditorRoutes: RouteObject[] = [
handle: { name: SQL_EDITOR_INSTANCE_MODULE },
},
{
- path: "projects/:project/sheets/:sheet",
- handle: { name: SQL_EDITOR_WORKSHEET_MODULE },
+ path: "projects/:project/savedQueries/:savedQuery",
+ handle: { name: SQL_EDITOR_SAVED_QUERY_MODULE },
},
{
path: "projects/:project/queryHistories/:queryHistory",
diff --git a/frontend/src/architecture/legacy-boundaries.test.ts b/frontend/src/architecture/legacy-boundaries.test.ts
index e027dad850..8a842c65dd 100644
--- a/frontend/src/architecture/legacy-boundaries.test.ts
+++ b/frontend/src/architecture/legacy-boundaries.test.ts
@@ -21,7 +21,7 @@ const currentUserMigrationSources = import.meta.glob(
"../modules/ai/components/**/*.{ts,tsx}",
"../api/middlewares/activeInterceptorMiddleware.ts",
"../utils/pagination.ts",
- "../utils/v1/worksheet.ts",
+ "../utils/v1/savedQuery.ts",
],
{
query: "?raw",
diff --git a/frontend/src/components/Quickstart.test.tsx b/frontend/src/components/Quickstart.test.tsx
index 736c4bd060..703c3ed924 100644
--- a/frontend/src/components/Quickstart.test.tsx
+++ b/frontend/src/components/Quickstart.test.tsx
@@ -51,7 +51,7 @@ vi.mock("@/stores/app", () => {
...state,
getOrFetchProjectByName: mocks.getOrFetchProjectByName,
fetchIssueByName: vi.fn(),
- getOrFetchWorksheetByName: vi.fn(),
+ getOrFetchSavedQueryByName: vi.fn(),
saveIntroStateByKey: mocks.saveIntroStateByKey,
});
return { useAppStore };
diff --git a/frontend/src/components/Quickstart.tsx b/frontend/src/components/Quickstart.tsx
index 748a2818bf..1fcf0fb592 100644
--- a/frontend/src/components/Quickstart.tsx
+++ b/frontend/src/components/Quickstart.tsx
@@ -8,7 +8,7 @@ import {
INSTANCE_ROUTE_DASHBOARD,
PROJECT_V1_ROUTE_DASHBOARD,
PROJECT_V1_ROUTE_ISSUE_DETAIL,
- SQL_EDITOR_WORKSHEET_MODULE,
+ SQL_EDITOR_SAVED_QUERY_MODULE,
WORKSPACE_ROUTE_MEMBERS,
} from "@/app/router/handles";
import { RouterLink } from "@/components/RouterLink";
@@ -54,7 +54,7 @@ interface IntroItem {
* - `getIntroStateByKey(...)` — per-task done flags and the global
* `hidden` flag (toggled when the user dismisses).
*
- * Async fetches (project / sample issue / sample worksheet) run on
+ * Async fetches (project / sample issue / sample saved query) run on
* mount and fall back to undefined when the sample data is missing
* (e.g. an upgraded workspace that never bootstrapped the sample).
*/
@@ -139,7 +139,7 @@ export function Quickstart() {
void (async () => {
const sheet = await useAppStore
.getState()
- .getOrFetchWorksheetByName(
+ .getOrFetchSavedQueryByName(
`${sampleProject.name}/sheets/${SAMPLE_SHEET_ID}`,
true /* silent */
);
@@ -171,10 +171,10 @@ export function Quickstart() {
{
name: t("quick-start.query-data"),
link: {
- name: SQL_EDITOR_WORKSHEET_MODULE,
+ name: SQL_EDITOR_SAVED_QUERY_MODULE,
params: {
project: SAMPLE_PROJECT_NAME,
- sheet: SAMPLE_SHEET_ID,
+ savedQuery: SAMPLE_SHEET_ID,
},
},
done: dataQueried,
diff --git a/frontend/src/components/monaco/MonacoEditor.tsx b/frontend/src/components/monaco/MonacoEditor.tsx
index 682654d60e..b5abb94cf2 100644
--- a/frontend/src/components/monaco/MonacoEditor.tsx
+++ b/frontend/src/components/monaco/MonacoEditor.tsx
@@ -94,7 +94,7 @@ export interface MonacoEditorProps {
* When `true` (default), the editor's height grows with content,
* clamped to `[min, max]`. When `false`, the inner editor container
* fills its parent's height (`h-full`) and `min`/`max` are ignored.
- * Use the parent-fill mode for surfaces like the worksheet
+ * Use the parent-fill mode for surfaces like the saved query
* `SQLEditor`, where the editor is expected to occupy the full
* height of an `NSplit`/flex column.
*/
diff --git a/frontend/src/components/monaco/core.ts b/frontend/src/components/monaco/core.ts
index aec3a48eb1..7d0c8c6bf0 100644
--- a/frontend/src/components/monaco/core.ts
+++ b/frontend/src/components/monaco/core.ts
@@ -41,7 +41,7 @@ const registerEditorThemes = async () => {
* name is a silent no-op, which leaves the global theme stuck on
* whatever was last applied (and Monaco's theme is global, not
* per-instance, so a stale `vs-dark` from a recently-disposed
- * terminal editor can bleed into a freshly-mounted worksheet editor).
+ * terminal editor can bleed into a freshly-mounted saved query editor).
*/
export const getResolvedTheme = (requested = "vs"): string => {
if (state.registeredThemes.has(requested)) return requested;
diff --git a/frontend/src/components/monaco/statement-range-store.ts b/frontend/src/components/monaco/statement-range-store.ts
index f1e212ddc4..ef3f52b2b8 100644
--- a/frontend/src/components/monaco/statement-range-store.ts
+++ b/frontend/src/components/monaco/statement-range-store.ts
@@ -12,7 +12,7 @@
// This is intentionally NOT persisted to localStorage: a page reload creates a
// fresh model, which re-triggers `didOpen` and re-fetches the ranges from the
// backend. Keeping it in memory avoids unbounded storage growth and stale
-// ranges that no longer match a worksheet's content.
+// ranges that no longer match a saved query's content.
export type StatementRange = {
startLineNumber: number;
diff --git a/frontend/src/components/ui/tree-utils.ts b/frontend/src/components/ui/tree-utils.ts
index b31e7b607f..0dca872113 100644
--- a/frontend/src/components/ui/tree-utils.ts
+++ b/frontend/src/components/ui/tree-utils.ts
@@ -1,7 +1,7 @@
/**
* Generic tree-shape contract — every tree node has a stable string key
* and (optionally) child nodes of the same shape. Both
- * `WorksheetFolderNode` and `SQLEditorTreeNode` satisfy this.
+ * `SavedQueryFolderNode` and `SQLEditorTreeNode` satisfy this.
*/
export interface VisibleRowNode {
readonly key: string;
diff --git a/frontend/src/hooks/useWorksheetAndTab.ts b/frontend/src/hooks/useSavedQueryAndTab.ts
similarity index 62%
rename from frontend/src/hooks/useWorksheetAndTab.ts
rename to frontend/src/hooks/useSavedQueryAndTab.ts
index a0009e6b91..bdccbe2f7f 100644
--- a/frontend/src/hooks/useWorksheetAndTab.ts
+++ b/frontend/src/hooks/useSavedQueryAndTab.ts
@@ -2,33 +2,33 @@ import { useCurrentUser } from "@/hooks/useAppState";
import { useCurrentSQLEditorTab } from "@/modules/sql-editor/store/tab";
import { useAppStore } from "@/stores/app";
import { extractUserEmail } from "@/stores/modules/v1/common";
-import type { Worksheet } from "@/types/proto-es/v1/worksheet_service_pb";
+import type { SavedQuery } from "@/types/proto-es/v1/saved_query_service_pb";
import {
getSheetStatement,
getStatementSize,
- isWorksheetWritableV1,
+ isSavedQueryWritableV1,
} from "@/utils";
-export interface WorksheetAndTab {
- currentSheet: Worksheet | undefined;
+export interface SavedQueryAndTab {
+ currentSheet: SavedQuery | undefined;
isCreator: boolean;
isReadOnly: boolean;
}
/**
* React replacement for the Pinia `useWorkSheetAndTabStore`. Derives the
- * worksheet bound to the current SQL editor tab plus creator / read-only
- * flags. The tab comes from the Zustand tab store; the worksheet is read
- * from the Zustand worksheet slice via `useAppStore` so cache hydration
+ * saved query bound to the current SQL editor tab plus creator / read-only
+ * flags. The tab comes from the Zustand tab store; the saved query is read
+ * from the Zustand saved query slice via `useAppStore` so cache hydration
* and in-place edits re-render.
*/
-export const useWorksheetAndTab = (): WorksheetAndTab => {
+export const useSavedQueryAndTab = (): SavedQueryAndTab => {
const currentTab = useCurrentSQLEditorTab();
- const worksheetName = currentTab?.worksheet;
+ const savedQueryName = currentTab?.savedQuery;
const me = useCurrentUser();
const currentSheet = useAppStore((s) =>
- worksheetName ? s.getWorksheetByName(worksheetName) : undefined
+ savedQueryName ? s.getSavedQueryByName(savedQueryName) : undefined
);
const isCreator = currentSheet
@@ -43,7 +43,7 @@ export const useWorksheetAndTab = (): WorksheetAndTab => {
if (getStatementSize(statement) !== currentSheet.contentSize) {
isReadOnly = true;
} else {
- isReadOnly = !isWorksheetWritableV1(currentSheet);
+ isReadOnly = !isSavedQueryWritableV1(currentSheet);
}
}
diff --git a/frontend/src/lib/sqlEditorConnection.ts b/frontend/src/lib/sqlEditorConnection.ts
index 6215ab4def..baa503d991 100644
--- a/frontend/src/lib/sqlEditorConnection.ts
+++ b/frontend/src/lib/sqlEditorConnection.ts
@@ -54,22 +54,22 @@ export const isConnectedSQLEditorTab = (tab: SQLEditorTab): boolean => {
};
/**
- * Resolves the connection record for a worksheet by hydrating its database
+ * Resolves the connection record for a saved query by hydrating its database
* through the React app store. Bails on the `unknownDatabase` fallback so a
* draft tab whose database was deleted or no longer readable doesn't get
* `instances/-1/databases/-1` written into its connection — downstream
- * `migrateDraftsFromCache` would attempt to create a worksheet against that
+ * `migrateDraftsFromCache` would attempt to create a saved query against that
* bogus target and drop the local draft on failure.
*/
-export const extractWorksheetConnection = async (worksheet: {
+export const extractSavedQueryConnection = async (savedQuery: {
database: string;
}): Promise<SQLEditorConnection> => {
const connection = emptySQLEditorConnection();
- if (worksheet.database) {
+ if (savedQuery.database) {
try {
const database = await useAppStore
.getState()
- .getOrFetchDatabaseByName(worksheet.database);
+ .getOrFetchDatabaseByName(savedQuery.database);
if (isValidDatabaseName(database.name)) {
const { instance } = extractDatabaseResourceName(database.name);
connection.instance = instance;
diff --git a/frontend/src/locales/en-US.json b/frontend/src/locales/en-US.json
index f86adc9be7..933ce71dab 100644
--- a/frontend/src/locales/en-US.json
+++ b/frontend/src/locales/en-US.json
@@ -2157,6 +2157,9 @@
},
"task-execution-errors": "Task execution errors"
},
+ "saved-query": {
+ "self": "Saved queries"
+ },
"schema-diagram": {
"fit-content-with-view": "Fit content within view",
"self": "Schema Diagram"
@@ -2866,28 +2869,28 @@
"sheet": {
"filter": {
"only-show-starred": "Only show starred",
- "show-draft": "Show draft",
+ "show-draft": "Show drafts",
"show-mine": "Show mine",
"show-shared": "Show shared"
},
"hint-tips": {
- "confirm-multi-delete-content": "The selected worksheets and folders will be permanently deleted.",
+ "confirm-multi-delete-content": "The selected saved queries and folders will be permanently deleted.",
"confirm-multi-delete-title": "Delete selected items?",
- "confirm-to-delete-sheet-title": "Confirm to delete this worksheet?",
- "confirm-to-duplicate-sheet": "Confirm to duplicate this worksheet?",
- "delete-all-sheets": "Delete all files",
- "duplicate-folder-name-content": "Do you want to merge all subfolders and files into the existing folder \"{{folder}}\"?",
+ "confirm-to-delete-sheet-title": "Delete this saved query?",
+ "confirm-to-duplicate-sheet": "Duplicate this saved query?",
+ "delete-all-sheets": "Delete all",
+ "duplicate-folder-name-content": "Do you want to merge all subfolders and saved queries into the existing folder \"{{folder}}\"?",
"duplicate-folder-name-title": "Duplicate folder name",
"move-to-root-folder": "Move to root folder",
- "non-empty-folder-content": "Do you want to move all worksheets into the root folder or just delete them?",
+ "non-empty-folder-content": "Do you want to move all saved queries into the root folder or just delete them?",
"non-empty-folder-title": "Non-empty folder"
},
"mine": "Mine",
- "move-worksheets": "Move worksheets",
+ "move-saved-queries": "Move saved queries",
"notifications": {
- "duplicate-success": "Successfully duplicate the worksheet"
+ "duplicate-success": "Saved query duplicated"
},
- "search-sheets": "Search Sheets",
+ "search-sheets": "Search saved queries",
"shared": "Shared"
},
"sql-editor": {
@@ -2946,7 +2949,7 @@
"choose-folder": "Choose or create folder",
"choose-folder-tips": "You can create a new folder by entering a non-existent path. The folders should be joined with a \"/\".",
"click-to-sync-now": "Click to sync now",
- "close-sheet": "Close sheet",
+ "close-sheet": "Close tab",
"column-display-format": "Column Display Format",
"connect-in-admin-mode": "Connect in admin mode",
"connect-to-a-database": "Connect to database",
@@ -2983,13 +2986,13 @@
"hex-format": "Hexadecimal format",
"hint-tips": {
"confirm-to-close-unsaved-sheet": {
- "content": "Close the sheet and lose any unsaved data?",
- "title": "Close the unsaved sheet?"
+ "content": "Close the tab and lose any unsaved changes?",
+ "title": "Close the unsaved tab?"
}
},
"invalid-database": "Invalid database {{database}}",
"last-synced": "Last synced: <time></time>",
- "link-access": "Link access",
+ "link-access": "Access",
"loading-data": "Loading Data...",
"loading-databases": "Loading Databases...",
"manage-connections": "Manage connections",
@@ -3007,11 +3010,11 @@
"preview-table-data": "Preview table data",
"previous-row": "Previous Row",
"private": "Private",
- "private-desc": "Only you can access this sheet",
- "project-read": "Project read",
- "project-read-desc": "Both sheet owner and users with \"bb.worksheets.manage\" permission can read/write, other project users with \"bb.worksheets.get\" permission can read",
- "project-write": "Project write",
- "project-write-desc": "Both sheet owner and project users with \"bb.worksheets.get\" permission can read/write",
+ "private-desc": "Only you can access this saved query",
+ "project-read": "Project can view",
+ "project-read-desc": "Project members can view this saved query. Only the owner and admins can edit it.",
+ "project-write": "Project can edit",
+ "project-write-desc": "Project members can view and edit this saved query.",
"query-context": {
"admin-data-source-is-disallowed-to-query": "Admin data source is disallowed to query."
},
@@ -3042,7 +3045,7 @@
},
"rows-affected": "rows affected",
"rows-upper-limit": "reached the limit of query results",
- "save-sheet": "Save Sheet",
+ "save-sheet": "Save query",
"scroll-to-bottom": "Scroll to the bottom",
"scroll-to-top": "Scroll to the top",
"search-history-by-statement": "Search by statement",
@@ -3061,7 +3064,7 @@
"context-menu": {
"actions": {
"add-folder": "Add folder",
- "add-worksheet": "Add worksheet",
+ "add-saved-query": "New query",
"close": "Close",
"close-all": "Close all",
"close-others": "Close others",
@@ -3071,14 +3074,14 @@
"rename": "Rename"
}
},
- "unsaved-worksheet": "You have unsaved worksheet."
+ "unsaved-changes": "You have unsaved changes."
},
"table-empty-placeholder": "Click Run to execute the query.",
"table-view": "Table view",
"text-format": "Text format",
"unable-to-connect-database": "Unable to connect to database {{name}}",
"upload-file": "Upload file",
- "url-copied-to-clipboard": "The URL is copied to your clipboard",
+ "url-copied-to-clipboard": "Link copied to clipboard",
"vertical-display": "Vertical display",
"view-database-detail": "View database detail",
"view-detail": "View detail",
@@ -3393,9 +3396,6 @@
"self": "Your two-factor secret"
}
},
- "worksheet": {
- "self": "Worksheet"
- },
"workspace-setup-guide": {
"actions": {
"change": "Create database change",
diff --git a/frontend/src/locales/es-ES.json b/frontend/src/locales/es-ES.json
index 21712f55fa..09a704b3aa 100644
--- a/frontend/src/locales/es-ES.json
+++ b/frontend/src/locales/es-ES.json
@@ -2157,6 +2157,9 @@
},
"task-execution-errors": "Errores de ejecución de tareas"
},
+ "saved-query": {
+ "self": "Consultas guardadas"
+ },
"schema-diagram": {
"fit-content-with-view": "Ajustar contenido dentro de la vista",
"self": "Diagrama de Esquema"
@@ -2865,29 +2868,29 @@
},
"sheet": {
"filter": {
- "only-show-starred": "Solo programa protagonizado",
- "show-draft": "Mostrar borrador",
- "show-mine": "Muéstrame el mío",
- "show-shared": "Mostrar compartido"
+ "only-show-starred": "Mostrar solo destacadas",
+ "show-draft": "Mostrar borradores",
+ "show-mine": "Mostrar mías",
+ "show-shared": "Mostrar compartidas"
},
"hint-tips": {
- "confirm-multi-delete-content": "Las hojas de cálculo y carpetas seleccionadas se eliminarán permanentemente.",
+ "confirm-multi-delete-content": "Las consultas guardadas y carpetas seleccionadas se eliminarán permanentemente.",
"confirm-multi-delete-title": "¿Eliminar los elementos seleccionados?",
- "confirm-to-delete-sheet-title": "¿Confirmar la eliminación de esta hoja de cálculo?",
- "confirm-to-duplicate-sheet": "¿Confirmar para duplicar esta hoja?",
- "delete-all-sheets": "Eliminar todos los archivos",
- "duplicate-folder-name-content": "¿Desea fusionar todas las subcarpetas y archivos en la carpeta existente \"{{folder}}\"?",
+ "confirm-to-delete-sheet-title": "¿Eliminar esta consulta guardada?",
+ "confirm-to-duplicate-sheet": "¿Duplicar esta consulta guardada?",
+ "delete-all-sheets": "Eliminar todo",
+ "duplicate-folder-name-content": "¿Desea fusionar todas las subcarpetas y consultas guardadas en la carpeta existente \"{{folder}}\"?",
"duplicate-folder-name-title": "Nombre de carpeta duplicado",
"move-to-root-folder": "Mover a la carpeta raíz",
- "non-empty-folder-content": "¿Desea mover todas las hojas de cálculo a la carpeta raíz o simplemente eliminarlas?",
- "non-empty-folder-title": "carpeta no vacía"
+ "non-empty-folder-content": "¿Desea mover todas las consultas guardadas a la carpeta raíz o simplemente eliminarlas?",
+ "non-empty-folder-title": "Carpeta no vacía"
},
"mine": "Mío",
- "move-worksheets": "Hojas de trabajo de movimiento",
+ "move-saved-queries": "Mover consultas guardadas",
"notifications": {
- "duplicate-success": "Duplicado con éxito en \"Mis hojas\""
+ "duplicate-success": "Consulta guardada duplicada"
},
- "search-sheets": "Hojas de búsqueda",
+ "search-sheets": "Buscar consultas guardadas",
"shared": "Compartido"
},
"sql-editor": {
@@ -2946,7 +2949,7 @@
"choose-folder": "Seleccionar o crear una carpeta",
"choose-folder-tips": "Puedes crear una nueva carpeta introduciendo una ruta que no exista. Las carpetas deben unirse con una barra diagonal (\"/\").",
"click-to-sync-now": "Haga clic para sincronizar ahora",
- "close-sheet": "Cerrar hoja",
+ "close-sheet": "Cerrar pestaña",
"column-display-format": "Formato de visualización de columna",
"connect-in-admin-mode": "Conectar en modo administrador",
"connect-to-a-database": "Conectar a base de datos",
@@ -2983,13 +2986,13 @@
"hex-format": "Formato hexadecimal",
"hint-tips": {
"confirm-to-close-unsaved-sheet": {
- "content": "¿Cerrar la hoja y perder cualquier dato no guardado?",
- "title": "¿Cerrar la hoja no guardada?"
+ "content": "¿Cerrar la pestaña y perder los cambios no guardados?",
+ "title": "¿Cerrar la pestaña no guardada?"
}
},
"invalid-database": "Base de datos no válida {{database}}",
"last-synced": "Última sincronización: <time></time>",
- "link-access": "Acceso al enlace",
+ "link-access": "Acceso",
"loading-data": "Cargando datos...",
"loading-databases": "Cargando bases de datos...",
"manage-connections": "Gestionar las conexiones",
@@ -3007,11 +3010,11 @@
"preview-table-data": "Vista previa de datos de la tabla",
"previous-row": "Fila anterior",
"private": "Privado",
- "private-desc": "Solo tú puedes acceder a esta hoja",
- "project-read": "Lectura del proyecto",
- "project-read-desc": "Tanto el propietario de la hoja como los usuarios con permiso \"bb.worksheets.manage\" pueden leer/escribir, otros usuarios del proyecto con permiso \"bb.worksheets.get\" pueden leer",
- "project-write": "Escritura del proyecto",
- "project-write-desc": "Tanto el propietario de la hoja como los usuarios del proyecto con permiso \"bb.worksheets.get\" pueden leer/escribir",
+ "private-desc": "Solo tú puedes acceder a esta consulta guardada",
+ "project-read": "El proyecto puede ver",
+ "project-read-desc": "Los miembros del proyecto pueden ver esta consulta guardada. Solo el propietario y los administradores pueden editarla.",
+ "project-write": "El proyecto puede editar",
+ "project-write-desc": "Los miembros del proyecto pueden ver y editar esta consulta guardada.",
"query-context": {
"admin-data-source-is-disallowed-to-query": "No se permite realizar consultas a la fuente de datos del administrador."
},
@@ -3042,7 +3045,7 @@
},
"rows-affected": "filas afectadas",
"rows-upper-limit": "se ha alcanzado el límite de resultados de la consulta",
- "save-sheet": "Guardar hoja",
+ "save-sheet": "Guardar consulta",
"scroll-to-bottom": "Desplazarse hacia abajo",
"scroll-to-top": "Desplazarse hacia arriba",
"search-history-by-statement": "Búsqueda por enunciado",
@@ -3061,7 +3064,7 @@
"context-menu": {
"actions": {
"add-folder": "Agregar carpeta",
- "add-worksheet": "Agregar hoja de trabajo",
+ "add-saved-query": "Nueva consulta",
"close": "Cerrar",
"close-all": "Cerrar todo",
"close-others": "cerrar otros",
@@ -3071,14 +3074,14 @@
"rename": "Renombrar"
}
},
- "unsaved-worksheet": "Tiene una hoja de trabajo sin guardar."
+ "unsaved-changes": "Tiene cambios sin guardar."
},
"table-empty-placeholder": "Haga clic en Ejecutar para ejecutar la consulta.",
"table-view": "Vista de tabla",
"text-format": "Formato de texto",
"unable-to-connect-database": "No se puede conectar a la base de datos {{name}}",
"upload-file": "Subir archivo",
- "url-copied-to-clipboard": "La URL se copia al portapapeles.",
+ "url-copied-to-clipboard": "Enlace copiado al portapapeles",
"vertical-display": "Pantalla vertical",
"view-database-detail": "Ver detalle de la base de datos",
"view-detail": "Ver detalle",
@@ -3393,9 +3396,6 @@
"self": "Su secreto de dos factores"
}
},
- "worksheet": {
- "self": "Hoja de trabajo"
- },
"workspace-setup-guide": {
"actions": {
"change": "Crear cambio de base de datos",
diff --git a/frontend/src/locales/ja-JP.json b/frontend/src/locales/ja-JP.json
index fb9961d751..c268670685 100644
--- a/frontend/src/locales/ja-JP.json
+++ b/frontend/src/locales/ja-JP.json
@@ -2157,6 +2157,9 @@
},
"task-execution-errors": "タスク実行エラー"
},
+ "saved-query": {
+ "self": "保存済みクエリ"
+ },
"schema-diagram": {
"fit-content-with-view": "ビューに自動的に適応します",
"self": "スキーマ図"
@@ -2871,23 +2874,23 @@
"show-shared": "共有を表示"
},
"hint-tips": {
- "confirm-multi-delete-content": "選択したワークシートとフォルダーは完全に削除されます。",
+ "confirm-multi-delete-content": "選択した保存済みクエリとフォルダーは完全に削除されます。",
"confirm-multi-delete-title": "選択した項目を削除しますか?",
- "confirm-to-delete-sheet-title": "このワークシートを削除しますか?",
- "confirm-to-duplicate-sheet": "このワークシートをコピーしてもよろしいですか?",
- "delete-all-sheets": "すべてのファイルを削除する",
- "duplicate-folder-name-content": "すべてのサブフォルダーとファイルを既存のフォルダー \"{{folder}}\" にマージしますか?",
+ "confirm-to-delete-sheet-title": "この保存済みクエリを削除しますか?",
+ "confirm-to-duplicate-sheet": "この保存済みクエリを複製しますか?",
+ "delete-all-sheets": "すべて削除",
+ "duplicate-folder-name-content": "すべてのサブフォルダーと保存済みクエリを既存のフォルダー \"{{folder}}\" にマージしますか?",
"duplicate-folder-name-title": "重複したフォルダ名",
"move-to-root-folder": "ルートフォルダに移動する",
- "non-empty-folder-content": "すべてのワークシートをルート フォルダーに移動しますか、それとも削除するだけですか?",
+ "non-empty-folder-content": "すべての保存済みクエリをルート フォルダーに移動しますか、それとも削除するだけですか?",
"non-empty-folder-title": "空でないフォルダ"
},
- "mine": "マイワークシート",
- "move-worksheets": "ワークシートを移動する",
+ "mine": "マイクエリ",
+ "move-saved-queries": "保存済みクエリを移動する",
"notifications": {
- "duplicate-success": "「マイワークシート」にコピーされました"
+ "duplicate-success": "保存済みクエリを複製しました"
},
- "search-sheets": "ワークシートの検索",
+ "search-sheets": "保存済みクエリの検索",
"shared": "共有"
},
"sql-editor": {
@@ -2946,7 +2949,7 @@
"choose-folder": "フォルダを選択または作成",
"choose-folder-tips": "存在しないパスを入力することで新しいフォルダを作成できます。フォルダは「/」で結合する必要があります。",
"click-to-sync-now": "クリックして今すぐ同期します",
- "close-sheet": "ワークシートを閉じる",
+ "close-sheet": "タブを閉じる",
"column-display-format": "列の表示形式",
"connect-in-admin-mode": "管理者モードで接続する",
"connect-to-a-database": "データベースに接続",
@@ -2983,13 +2986,13 @@
"hex-format": "16進形式",
"hint-tips": {
"confirm-to-close-unsaved-sheet": {
- "content": "現在のワークシートを閉じると、保存されていないデータはすべて失われますか?",
- "title": "未保存のワークシートを閉じてもよろしいですか?"
+ "content": "タブを閉じると、保存されていない変更はすべて失われます。",
+ "title": "未保存のタブを閉じてもよろしいですか?"
}
},
"invalid-database": "無効なデータベース {{database}}",
"last-synced": "最終同期時間: <time></time>",
- "link-access": "リンクアクセス",
+ "link-access": "アクセス",
"loading-data": "データのロード...",
"loading-databases": "データベース情報をロードしています...",
"manage-connections": "接続を管理する",
@@ -3007,11 +3010,11 @@
"preview-table-data": "テーブルデータのプレビュー",
"previous-row": "前の行",
"private": "プライベート",
- "private-desc": "このシートにアクセスできるのはあなただけです",
- "project-read": "プロジェクト内で読み取り可能",
- "project-read-desc": "シートの所有者と「bb.worksheets.manage」権限を持つユーザーは読み取り/書き込みが可能で、「bb.worksheets.get」権限を持つ他のプロジェクトユーザーは読み取りが可能です。",
- "project-write": "プロジェクト内での読み取りと書き込み",
- "project-write-desc": "シート所有者と「bb.worksheets.get」権限を持つプロジェクトユーザーの両方が読み取り/書き込みできます。",
+ "private-desc": "このクエリにアクセスできるのはあなただけです",
+ "project-read": "プロジェクト内で閲覧可",
+ "project-read-desc": "プロジェクトメンバーはこのクエリを閲覧できます。編集できるのは所有者と管理者のみです。",
+ "project-write": "プロジェクト内で編集可",
+ "project-write-desc": "プロジェクトメンバーはこのクエリを閲覧・編集できます。",
"query-context": {
"admin-data-source-is-disallowed-to-query": "管理者データ ソースはクエリできません。"
},
@@ -3042,7 +3045,7 @@
},
"rows-affected": "行に影響",
"rows-upper-limit": "クエリ結果の数が上限に達しました",
- "save-sheet": "ワークシートの保存",
+ "save-sheet": "クエリを保存",
"scroll-to-bottom": "末尾へスクロール",
"scroll-to-top": "先頭へスクロール",
"search-history-by-statement": "ステートメントで検索",
@@ -3061,7 +3064,7 @@
"context-menu": {
"actions": {
"add-folder": "フォルダを追加",
- "add-worksheet": "ワークシートを追加",
+ "add-saved-query": "新しいクエリ",
"close": "閉じる",
"close-all": "すべて閉じる",
"close-others": "その他を閉じる",
@@ -3071,14 +3074,14 @@
"rename": "名前の変更"
}
},
- "unsaved-worksheet": "保存されていないワークシートがあります。"
+ "unsaved-changes": "保存されていない変更があります。"
},
"table-empty-placeholder": "「実行」をクリックしてクエリを実行します。",
"table-view": "テーブルビュー",
"text-format": "テキスト形式",
"unable-to-connect-database": "データベース {{name}} に接続できません",
"upload-file": "ファイルをアップロードする",
- "url-copied-to-clipboard": "URLがクリップボードにコピーされました",
+ "url-copied-to-clipboard": "リンクをクリップボードにコピーしました",
"vertical-display": "縦型表示",
"view-database-detail": "データベースの詳細を表示する",
"view-detail": "詳細を見る",
@@ -3393,9 +3396,6 @@
"self": "二要素認証キー"
}
},
- "worksheet": {
- "self": "ワークシート"
- },
"workspace-setup-guide": {
"actions": {
"change": "データベース変更を作成",
diff --git a/frontend/src/locales/vi-VN.json b/frontend/src/locales/vi-VN.json
index 3f3529e755..1a0781ade4 100644
--- a/frontend/src/locales/vi-VN.json
+++ b/frontend/src/locales/vi-VN.json
@@ -2157,6 +2157,9 @@
},
"task-execution-errors": "Lỗi thực hiện tác vụ"
},
+ "saved-query": {
+ "self": "Truy vấn đã lưu"
+ },
"schema-diagram": {
"fit-content-with-view": "Điều chỉnh nội dung vừa với khung nhìn",
"self": "Sơ đồ Lược đồ"
@@ -2871,23 +2874,23 @@
"show-shared": "Hiển thị chia sẻ"
},
"hint-tips": {
- "confirm-multi-delete-content": "Các bảng tính và thư mục đã chọn sẽ bị xóa vĩnh viễn.",
+ "confirm-multi-delete-content": "Các truy vấn đã lưu và thư mục đã chọn sẽ bị xóa vĩnh viễn.",
"confirm-multi-delete-title": "Xóa các mục đã chọn?",
- "confirm-to-delete-sheet-title": "Xác nhận xóa bảng tính này?",
- "confirm-to-duplicate-sheet": "Xác nhận nhân bản trang tính này?",
- "delete-all-sheets": "Xóa tất cả các tập tin",
- "duplicate-folder-name-content": "Bạn có muốn hợp nhất tất cả các thư mục con và tệp vào thư mục hiện có \"{{folder}}\" không?",
+ "confirm-to-delete-sheet-title": "Xóa truy vấn đã lưu này?",
+ "confirm-to-duplicate-sheet": "Nhân bản truy vấn đã lưu này?",
+ "delete-all-sheets": "Xóa tất cả",
+ "duplicate-folder-name-content": "Bạn có muốn hợp nhất tất cả các thư mục con và truy vấn đã lưu vào thư mục hiện có \"{{folder}}\" không?",
"duplicate-folder-name-title": "Tên thư mục trùng lặp",
"move-to-root-folder": "Di chuyển đến thư mục gốc",
- "non-empty-folder-content": "Bạn muốn di chuyển tất cả các trang tính vào thư mục gốc hay chỉ xóa chúng?",
+ "non-empty-folder-content": "Bạn muốn di chuyển tất cả truy vấn đã lưu vào thư mục gốc hay chỉ xóa chúng?",
"non-empty-folder-title": "Thư mục không trống"
},
"mine": "Của tôi",
- "move-worksheets": "Di chuyển các trang tính",
+ "move-saved-queries": "Di chuyển truy vấn đã lưu",
"notifications": {
- "duplicate-success": "Đã nhân bản thành công vào \"Trang tính của tôi\""
+ "duplicate-success": "Đã nhân bản truy vấn đã lưu"
},
- "search-sheets": "Tìm kiếm Trang tính",
+ "search-sheets": "Tìm kiếm truy vấn đã lưu",
"shared": "Được chia sẻ"
},
"sql-editor": {
@@ -2946,7 +2949,7 @@
"choose-folder": "Chọn hoặc tạo thư mục",
"choose-folder-tips": "Bạn có thể tạo một thư mục mới bằng cách nhập một đường dẫn không tồn tại. Các thư mục phải được nối bằng dấu \"/\".",
"click-to-sync-now": "Nhấp để đồng bộ ngay",
- "close-sheet": "Đóng trang tính",
+ "close-sheet": "Đóng thẻ",
"column-display-format": "Định dạng hiển thị cột",
"connect-in-admin-mode": "Kết nối ở chế độ quản trị",
"connect-to-a-database": "Kết nối cơ sở dữ liệu",
@@ -2983,13 +2986,13 @@
"hex-format": "Định dạng thập lục phân",
"hint-tips": {
"confirm-to-close-unsaved-sheet": {
- "content": "Đóng trang tính và mất bất kỳ dữ liệu chưa lưu nào?",
- "title": "Đóng trang tính chưa lưu?"
+ "content": "Đóng thẻ và mất các thay đổi chưa lưu?",
+ "title": "Đóng thẻ chưa lưu?"
}
},
"invalid-database": "Cơ sở dữ liệu không hợp lệ {{database}}",
"last-synced": "Đã đồng bộ lần cuối: <time></time>",
- "link-access": "Truy cập liên kết",
+ "link-access": "Quyền truy cập",
"loading-data": "Đang tải Dữ liệu...",
"loading-databases": "Đang tải Cơ sở dữ liệu...",
"manage-connections": "Quản lý kết nối",
@@ -3007,11 +3010,11 @@
"preview-table-data": "Xem trước dữ liệu bảng",
"previous-row": "Dòng trước",
"private": "Riêng tư",
- "private-desc": "Chỉ bạn mới có thể truy cập trang tính này",
- "project-read": "Đọc dự án",
- "project-read-desc": "Cả chủ sở hữu trang tính và người dùng có quyền \"bb.worksheets.manage\" đều có thể đọc/ghi, những người dùng dự án khác có quyền \"bb.worksheets.get\" có thể đọc",
- "project-write": "Ghi dự án",
- "project-write-desc": "Cả chủ sở hữu trang tính và người dùng dự án có quyền \"bb.worksheets.get\" đều có thể đọc/ghi",
+ "private-desc": "Chỉ bạn mới có thể truy cập truy vấn đã lưu này",
+ "project-read": "Dự án có thể xem",
+ "project-read-desc": "Thành viên dự án có thể xem truy vấn đã lưu này. Chỉ chủ sở hữu và quản trị viên mới có thể chỉnh sửa.",
+ "project-write": "Dự án có thể chỉnh sửa",
+ "project-write-desc": "Thành viên dự án có thể xem và chỉnh sửa truy vấn đã lưu này.",
"query-context": {
"admin-data-source-is-disallowed-to-query": "Nguồn dữ liệu quản trị không được phép truy vấn."
},
@@ -3042,7 +3045,7 @@
},
"rows-affected": "dòng bị ảnh hưởng",
"rows-upper-limit": "đã đạt đến giới hạn kết quả truy vấn",
- "save-sheet": "Lưu trang tính",
+ "save-sheet": "Lưu truy vấn",
"scroll-to-bottom": "Cuộn xuống cuối",
"scroll-to-top": "Cuộn lên đầu",
"search-history-by-statement": "Tìm kiếm theo câu lệnh",
@@ -3061,24 +3064,24 @@
"context-menu": {
"actions": {
"add-folder": "Thêm thư mục",
- "add-worksheet": "Thêm bảng tính",
+ "add-saved-query": "Truy vấn mới",
"close": "Đóng",
"close-all": "Đóng tất cả",
- "close-others": "Đóng các trang tính khác",
- "close-saved": "Đóng các trang tính đã lưu",
- "close-to-the-right": "Đóng các trang tính bên phải",
+ "close-others": "Đóng các thẻ khác",
+ "close-saved": "Đóng các thẻ đã lưu",
+ "close-to-the-right": "Đóng các thẻ bên phải",
"multi-select": "Chọn nhiều",
"rename": "Đổi tên"
}
},
- "unsaved-worksheet": "Bạn có bảng tính chưa lưu."
+ "unsaved-changes": "Bạn có thay đổi chưa lưu."
},
"table-empty-placeholder": "Nhấp vào Chạy để thực hiện truy vấn.",
"table-view": "Chế độ xem bảng",
"text-format": "Định dạng văn bản",
"unable-to-connect-database": "Không thể kết nối đến cơ sở dữ liệu {{name}}",
"upload-file": "Tải lên tệp",
- "url-copied-to-clipboard": "URL đã được sao chép vào bảng nhớ tạm của bạn",
+ "url-copied-to-clipboard": "Đã sao chép liên kết vào bảng nhớ tạm",
"vertical-display": "Hiển thị dọc",
"view-database-detail": "Xem chi tiết cơ sở dữ liệu",
"view-detail": "Xem chi tiết",
@@ -3393,9 +3396,6 @@
"self": "Bí mật hai yếu tố của bạn"
}
},
- "worksheet": {
- "self": "Bảng tính"
- },
"workspace-setup-guide": {
"actions": {
"change": "Tạo thay đổi cơ sở dữ liệu",
diff --git a/frontend/src/locales/zh-CN.json b/frontend/src/locales/zh-CN.json
index f5c45332e6..1d3502a5c9 100644
--- a/frontend/src/locales/zh-CN.json
+++ b/frontend/src/locales/zh-CN.json
@@ -2157,6 +2157,9 @@
},
"task-execution-errors": "任务执行错误"
},
+ "saved-query": {
+ "self": "已保存的查询"
+ },
"schema-diagram": {
"fit-content-with-view": "自动适应视图",
"self": "Schema 关系图"
@@ -2871,23 +2874,23 @@
"show-shared": "显示共享"
},
"hint-tips": {
- "confirm-multi-delete-content": "选中的工作表和文件夹将被永久删除。",
+ "confirm-multi-delete-content": "选中的已保存查询和文件夹将被永久删除。",
"confirm-multi-delete-title": "删除选中的项目?",
- "confirm-to-delete-sheet-title": "确认删除此工作表?",
- "confirm-to-duplicate-sheet": "确定要复制这条工作表?",
- "delete-all-sheets": "删除所有文件",
- "duplicate-folder-name-content": "是否要将所有子文件夹和文件合并到现有文件夹“{{folder}}”中?",
+ "confirm-to-delete-sheet-title": "确定要删除此查询吗?",
+ "confirm-to-duplicate-sheet": "确定要复制此查询吗?",
+ "delete-all-sheets": "全部删除",
+ "duplicate-folder-name-content": "是否要将所有子文件夹和已保存查询合并到现有文件夹“{{folder}}”中?",
"duplicate-folder-name-title": "重复的文件夹名称",
"move-to-root-folder": "移动到根文件夹",
- "non-empty-folder-content": "您是想将所有工作表移动到根文件夹,还是直接删除它们?",
+ "non-empty-folder-content": "您是想将所有已保存查询移动到根文件夹,还是直接删除它们?",
"non-empty-folder-title": "非空文件夹"
},
"mine": "我的",
- "move-worksheets": "移动工作表",
+ "move-saved-queries": "移动已保存的查询",
"notifications": {
- "duplicate-success": "已成功拷贝至“我的工作表”"
+ "duplicate-success": "查询已复制"
},
- "search-sheets": "搜索工作表",
+ "search-sheets": "搜索已保存的查询",
"shared": "共享的"
},
"sql-editor": {
@@ -2946,7 +2949,7 @@
"choose-folder": "选择或创建文件夹",
"choose-folder-tips": "您可以通过输入不存在的路径来创建新文件夹。文件夹之间应以\"/\"连接。",
"click-to-sync-now": "点击立即同步",
- "close-sheet": "关闭工作表",
+ "close-sheet": "关闭标签页",
"column-display-format": "列显示格式",
"connect-in-admin-mode": "以管理员模式连接",
"connect-to-a-database": "连接数据库",
@@ -2983,13 +2986,13 @@
"hex-format": "十六进制格式",
"hint-tips": {
"confirm-to-close-unsaved-sheet": {
- "content": "关闭当前工作表会丢失所有未保存的数据?",
- "title": "确定关闭未保存的工作表?"
+ "content": "关闭标签页会丢失所有未保存的更改?",
+ "title": "确定关闭未保存的标签页?"
}
},
"invalid-database": "数据库 {{database}} 无效",
"last-synced": "上次同步时间:<time></time>",
- "link-access": "链接访问权限",
+ "link-access": "访问权限",
"loading-data": "加载数据中...",
"loading-databases": "加载数据库信息...",
"manage-connections": "管理连接",
@@ -3007,11 +3010,11 @@
"preview-table-data": "预览表数据",
"previous-row": "上一行",
"private": "私有",
- "private-desc": "只有您自己可以访问此工作表",
- "project-read": "项目内可读",
- "project-read-desc": "工作表所有者和具有\"bb.worksheets.manage\"权限的用户都可以读/写,具有\"bb.worksheets.get\"权限的其他项目用户可以读取",
- "project-write": "项目内读写",
- "project-write-desc": "工作表所有者和具有\"bb.worksheets.get\"权限的项目用户都可以读/写",
+ "private-desc": "只有您自己可以访问此查询",
+ "project-read": "项目内可查看",
+ "project-read-desc": "项目成员可以查看此查询,仅所有者和管理员可以编辑。",
+ "project-write": "项目内可编辑",
+ "project-write-desc": "项目成员可以查看和编辑此查询。",
"query-context": {
"admin-data-source-is-disallowed-to-query": "禁止查询主数据源。"
},
@@ -3042,7 +3045,7 @@
},
"rows-affected": "行受影响",
"rows-upper-limit": "到达查询结果条数上限",
- "save-sheet": "保存工作表",
+ "save-sheet": "保存查询",
"scroll-to-bottom": "滚动到底部",
"scroll-to-top": "滚动到顶部",
"search-history-by-statement": "搜索 SQL 语句",
@@ -3061,7 +3064,7 @@
"context-menu": {
"actions": {
"add-folder": "添加文件夹",
- "add-worksheet": "添加工作表",
+ "add-saved-query": "新建查询",
"close": "关闭",
"close-all": "关闭所有",
"close-others": "关闭其他",
@@ -3071,14 +3074,14 @@
"rename": "重命名"
}
},
- "unsaved-worksheet": "您有未保存的工作表。"
+ "unsaved-changes": "您有未保存的更改。"
},
"table-empty-placeholder": "点击 \"运行\" 执行查询",
"table-view": "表格视图",
"text-format": "文本格式",
"unable-to-connect-database": "无法连接到数据库 {{name}}",
"upload-file": "上传文件",
- "url-copied-to-clipboard": "URL 已复制到剪贴板",
+ "url-copied-to-clipboard": "链接已复制到剪贴板",
"vertical-display": "竖向展示",
"view-database-detail": "查看数据库详情",
"view-detail": "查看详情",
@@ -3393,9 +3396,6 @@
"self": "双重认证密钥"
}
},
- "worksheet": {
- "self": "工作表"
- },
"workspace-setup-guide": {
"actions": {
"change": "创建数据库变更",
diff --git a/frontend/src/main.ts b/frontend/src/main.ts
index 18e7d1a78d..70ca0112b1 100644
--- a/frontend/src/main.ts
+++ b/frontend/src/main.ts
@@ -10,13 +10,20 @@ import "./lib/dayjs";
import "./lib/highlight";
import { initializeGA4 } from "./lib/ga4";
import { useAppStore } from "./stores/app";
-import { isDev, isRelease, migrateStorageKeys } from "./utils";
+import {
+ isDev,
+ isRelease,
+ migrateStorageKeys,
+ rewriteLegacyPath,
+} from "./utils";
console.debug("dev:", isDev());
console.debug("release:", isRelease());
-// Migrate renamed localStorage keys before any store reads from storage.
+// Migrate renamed localStorage keys before any store reads from storage,
+// and renamed URLs before the router mounts.
migrateStorageKeys();
+rewriteLegacyPath();
(async () => {
const store = useAppStore.getState();
diff --git a/frontend/src/modules/agent/logic/prompt.ts b/frontend/src/modules/agent/logic/prompt.ts
index a434d5f20c..b998677dbf 100644
--- a/frontend/src/modules/agent/logic/prompt.ts
+++ b/frontend/src/modules/agent/logic/prompt.ts
@@ -9,7 +9,7 @@ SQL & Queries:
- SQLService: execute SQL queries, export query results, SQL check/lint, parse SQL
- QueryHistoryService: query/export history records of SQL Editor sessions
- SheetService: internal saved SQL sheets (system use)
-- WorksheetService: user-facing saved SQL worksheets
+- SavedQueryService: user-facing saved SQL queries
Change Management:
- PlanService: create/update database change plans, plan checks, spec management
diff --git a/frontend/src/modules/agent/logic/tools/callApi.test.ts b/frontend/src/modules/agent/logic/tools/callApi.test.ts
index 3db9ce8f29..50a1c1770e 100644
--- a/frontend/src/modules/agent/logic/tools/callApi.test.ts
+++ b/frontend/src/modules/agent/logic/tools/callApi.test.ts
@@ -172,10 +172,10 @@ describe("callApi", () => {
test("coerces nested byte fields to base64 before sending the request", async () => {
mocks.getEndpointPath.mockReturnValue(
- "/bytebase.v1.WorksheetService/CreateWorksheet"
+ "/bytebase.v1.SavedQueryService/CreateSavedQuery"
);
mocks.getRequestSchema.mockReturnValue(
- schemas["bytebase.v1.CreateWorksheetRequest"]
+ schemas["bytebase.v1.CreateSavedQueryRequest"]
);
mocks.getSchema.mockImplementation(
(schemaName: string) => schemas[schemaName]
@@ -183,15 +183,15 @@ describe("callApi", () => {
mocks.fetch.mockResolvedValue(
createResponse({
status: 200,
- body: { name: "projects/demo/worksheets/1" },
+ body: { name: "projects/demo/savedQueries/1" },
})
);
await callApi({
- operationId: "WorksheetService/CreateWorksheet",
+ operationId: "SavedQueryService/CreateSavedQuery",
body: {
parent: "projects/demo",
- worksheet: {
+ savedQuery: {
content: "select 1;",
title: "demo",
},
@@ -200,7 +200,7 @@ describe("callApi", () => {
expect(getRequestBody()).toEqual({
parent: "projects/demo",
- worksheet: {
+ savedQuery: {
content: "c2VsZWN0IDE7",
title: "demo",
},
diff --git a/frontend/src/modules/sql-editor/AGENTS.md b/frontend/src/modules/sql-editor/AGENTS.md
index e2e2a8f5fa..d590262788 100644
--- a/frontend/src/modules/sql-editor/AGENTS.md
+++ b/frontend/src/modules/sql-editor/AGENTS.md
@@ -8,8 +8,8 @@ Follow `../../../AGENTS.md`. This directory owns the SQL Editor application subs
src/modules/sql-editor/
├── components/ # Route shell, panes, editor, results, schema browser, and UI
├── hooks/ # SQL Editor hooks backed by the app and editor stores
-├── store/ # Zustand editor, tab, worksheet, tree, history, and terminal state
-├── model/ # Framework-neutral worksheet tree and event models
+├── store/ # Zustand editor, tab, saved query, tree, history, and terminal state
+├── model/ # Framework-neutral saved query tree and event models
└── legacy/ # One-time persisted-data migration only
```
diff --git a/frontend/src/modules/sql-editor/components/AccessGrantRequestDrawer.tsx b/frontend/src/modules/sql-editor/components/AccessGrantRequestDrawer.tsx
index 45ddb2b201..38430cc72c 100644
--- a/frontend/src/modules/sql-editor/components/AccessGrantRequestDrawer.tsx
+++ b/frontend/src/modules/sql-editor/components/AccessGrantRequestDrawer.tsx
@@ -354,7 +354,7 @@ function AccessGrantRequestDrawerInner({
// Drawer Monaco portals outside `.sqleditor--wrapper`, so opt the
// canvas into the transparent-background rule and back it with the
// themed `bg-background` (from `sheetStyle`'s `--color-background`)
- // so it matches the active theme like the worksheet editor.
+ // so it matches the active theme like the saved query editor.
className="border rounded-[3px] h-40 bg-background sqleditor--monaco-transparent"
content={query}
language="sql"
diff --git a/frontend/src/modules/sql-editor/components/AdminModeButton.test.tsx b/frontend/src/modules/sql-editor/components/AdminModeButton.test.tsx
index fe709e29f3..28a8e577ee 100644
--- a/frontend/src/modules/sql-editor/components/AdminModeButton.test.tsx
+++ b/frontend/src/modules/sql-editor/components/AdminModeButton.test.tsx
@@ -13,7 +13,7 @@ const mocks = vi.hoisted(() => ({
state: {
project: "projects/test" as string,
allowAdmin: true,
- currentTabMode: "WORKSHEET" as string | undefined,
+ currentTabMode: "SAVED_QUERY" as string | undefined,
isDisconnected: false,
},
updateCurrentTab: vi.fn(),
@@ -83,10 +83,10 @@ const renderIntoContainer = (element: ReactElement) => {
beforeEach(async () => {
vi.clearAllMocks();
- // Default: allow admin, WORKSHEET mode, connected.
+ // Default: allow admin, SAVED_QUERY mode, connected.
mocks.state.project = "projects/test";
mocks.state.allowAdmin = true;
- mocks.state.currentTabMode = "WORKSHEET";
+ mocks.state.currentTabMode = "SAVED_QUERY";
mocks.state.isDisconnected = false;
mocks.useSQLEditorAllowAdmin.mockImplementation(() => mocks.state.allowAdmin);
({ AdminModeButton } = await import("./AdminModeButton"));
@@ -95,7 +95,7 @@ beforeEach(async () => {
describe("AdminModeButton", () => {
test("renders nothing when allowAdmin is false", () => {
mocks.state.allowAdmin = false;
- mocks.state.currentTabMode = "WORKSHEET";
+ mocks.state.currentTabMode = "SAVED_QUERY";
mocks.state.isDisconnected = false;
const { container, render, unmount } = renderIntoContainer(
<AdminModeButton />
@@ -105,7 +105,7 @@ describe("AdminModeButton", () => {
unmount();
});
- test("renders nothing when current tab mode is not WORKSHEET", () => {
+ test("renders nothing when current tab mode is not SAVED_QUERY", () => {
mocks.state.allowAdmin = true;
mocks.state.currentTabMode = "ADMIN";
mocks.state.isDisconnected = false;
@@ -119,7 +119,7 @@ describe("AdminModeButton", () => {
test("renders disabled button when isDisconnected is true", () => {
mocks.state.allowAdmin = true;
- mocks.state.currentTabMode = "WORKSHEET";
+ mocks.state.currentTabMode = "SAVED_QUERY";
mocks.state.isDisconnected = true;
const { container, render, unmount } = renderIntoContainer(
<AdminModeButton />
@@ -133,7 +133,7 @@ describe("AdminModeButton", () => {
test("click sets currentTab.mode to ADMIN", () => {
mocks.state.allowAdmin = true;
- mocks.state.currentTabMode = "WORKSHEET";
+ mocks.state.currentTabMode = "SAVED_QUERY";
mocks.state.isDisconnected = false;
const { container, render, unmount } = renderIntoContainer(
<AdminModeButton />
diff --git a/frontend/src/modules/sql-editor/components/AdminModeButton.tsx b/frontend/src/modules/sql-editor/components/AdminModeButton.tsx
index a0cb7db0e5..dbdd8a4bff 100644
--- a/frontend/src/modules/sql-editor/components/AdminModeButton.tsx
+++ b/frontend/src/modules/sql-editor/components/AdminModeButton.tsx
@@ -20,7 +20,7 @@ type AdminModeButtonProps = {
/**
* Replaces frontend/src/views/sql-editor/EditorCommon/AdminModeButton.vue.
* Visible only when the user has admin permission AND the current tab is
- * in WORKSHEET mode. Clicking switches the tab to ADMIN mode.
+ * in SAVED_QUERY mode. Clicking switches the tab to ADMIN mode.
*/
export function AdminModeButton({
size = "default",
@@ -35,7 +35,7 @@ export function AdminModeButton({
);
const isDisconnected = useIsDisconnected();
- if (!allowAdmin || currentTabMode !== "WORKSHEET") {
+ if (!allowAdmin || currentTabMode !== "SAVED_QUERY") {
return null;
}
diff --git a/frontend/src/modules/sql-editor/components/AsidePanel.tsx b/frontend/src/modules/sql-editor/components/AsidePanel.tsx
index dec82358cc..d6e8cbfff9 100644
--- a/frontend/src/modules/sql-editor/components/AsidePanel.tsx
+++ b/frontend/src/modules/sql-editor/components/AsidePanel.tsx
@@ -4,8 +4,8 @@ import { AccessPane } from "./AccessPane";
import { ActionBar } from "./AsidePanel/ActionBar";
import { GutterBar } from "./GutterBar";
import { HistoryPane } from "./HistoryPane";
+import { SavedQueryPane } from "./SavedQueryPane";
import { SchemaPane } from "./SchemaPane/SchemaPane";
-import { WorksheetPane } from "./WorksheetPane";
/**
* Replaces `frontend/src/views/sql-editor/AsidePanel/AsidePanel.vue`.
@@ -14,7 +14,7 @@ import { WorksheetPane } from "./WorksheetPane";
* 1. GutterBar (vertical icon rail) — fixed.
* 2. ActionBar — only when `asidePanelTab === "SCHEMA"` and the tab is
* connected to a database. Vertical button column for view drill-downs.
- * 3. Main column — active pane (Worksheet / Schema / History / Access).
+ * 3. Main column — active pane (SavedQuery / Schema / History / Access).
*
* Schema-viewer modal stays in `SQLEditorHomePage.vue` (Vue parent) since
* the embedded `TableSchemaViewer` is Vue-only; the React side triggers
@@ -37,7 +37,7 @@ export function AsidePanel() {
<div className="h-full flex-1 flex flex-col overflow-hidden">
<div className="flex-1 flex flex-row overflow-hidden">
<div className="h-full flex-1 flex flex-col pt-1 overflow-hidden">
- {asidePanelTab === "WORKSHEET" ? <WorksheetPane /> : null}
+ {asidePanelTab === "SAVED_QUERY" ? <SavedQueryPane /> : null}
{asidePanelTab === "SCHEMA" ? <SchemaPane /> : null}
{asidePanelTab === "HISTORY" ? <HistoryPane /> : null}
{asidePanelTab === "ACCESS" ? <AccessPane /> : null}
diff --git a/frontend/src/modules/sql-editor/components/ConnectionPane/ConnectionPane.test.tsx b/frontend/src/modules/sql-editor/components/ConnectionPane/ConnectionPane.test.tsx
index fffc23f552..b09b1f2cbb 100644
--- a/frontend/src/modules/sql-editor/components/ConnectionPane/ConnectionPane.test.tsx
+++ b/frontend/src/modules/sql-editor/components/ConnectionPane/ConnectionPane.test.tsx
@@ -18,7 +18,7 @@ const mocks = vi.hoisted(() => {
isInBatchMode: false,
currentTab: {
id: "t-1",
- mode: "WORKSHEET" as const,
+ mode: "SAVED_QUERY" as const,
title: "Untitled",
connection: { database: "", instance: "" },
batchQueryContext: {
@@ -439,7 +439,7 @@ beforeEach(async () => {
mocks.tabStore.isInBatchMode = false;
mocks.tabStore.currentTab = {
id: "t-1",
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
title: "Untitled",
connection: { database: "", instance: "" },
batchQueryContext: { databases: [], databaseGroups: [] },
diff --git a/frontend/src/modules/sql-editor/components/ConnectionPane/ConnectionPane.tsx b/frontend/src/modules/sql-editor/components/ConnectionPane/ConnectionPane.tsx
index 540f46ce11..4ddfebc1a6 100644
--- a/frontend/src/modules/sql-editor/components/ConnectionPane/ConnectionPane.tsx
+++ b/frontend/src/modules/sql-editor/components/ConnectionPane/ConnectionPane.tsx
@@ -435,7 +435,7 @@ function ConnectionPaneInner({ show, onMissingFeature }: Props) {
) {
setConnection({
database: queryable,
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
newTab: false,
batchQueryContext: ctx,
});
diff --git a/frontend/src/modules/sql-editor/components/ConnectionPane/actions.test.tsx b/frontend/src/modules/sql-editor/components/ConnectionPane/actions.test.tsx
index 034fa8a662..1bb49a2963 100644
--- a/frontend/src/modules/sql-editor/components/ConnectionPane/actions.test.tsx
+++ b/frontend/src/modules/sql-editor/components/ConnectionPane/actions.test.tsx
@@ -46,8 +46,8 @@ vi.mock("@/modules/sql-editor/store", () => ({
{
getState: () => ({
setAsidePanelTab: mocks.setAsidePanelTab,
- createWorksheet: vi.fn().mockResolvedValue(undefined),
- maybeUpdateWorksheet: vi.fn().mockResolvedValue(undefined),
+ createSavedQuery: vi.fn().mockResolvedValue(undefined),
+ maybeUpdateSavedQuery: vi.fn().mockResolvedValue(undefined),
}),
}
),
@@ -81,7 +81,7 @@ vi.mock("@/types", async () => {
};
});
-// The SQL-editor tab/worksheet stores now transitively load the Zustand
+// The SQL-editor tab/saved query stores now transitively load the Zustand
// app store (eagerly created). Stub it so the real `createAppStore()`
// (which reads `@/types` exports this test doesn't mock) never runs.
vi.mock("@/stores/app", () => {
diff --git a/frontend/src/modules/sql-editor/components/ConnectionPane/actions.tsx b/frontend/src/modules/sql-editor/components/ConnectionPane/actions.tsx
index 5228225463..a40193c6db 100644
--- a/frontend/src/modules/sql-editor/components/ConnectionPane/actions.tsx
+++ b/frontend/src/modules/sql-editor/components/ConnectionPane/actions.tsx
@@ -45,11 +45,11 @@ export type ConnectionMenuItem = {
readonly onSelect: () => void;
};
-const DEFAULT_TAB_MODE: SQLEditorTabMode = "WORKSHEET";
+const DEFAULT_TAB_MODE: SQLEditorTabMode = "SAVED_QUERY";
/**
* Replaces frontend/src/views/sql-editor/ConnectionPanel/ConnectionPane/actions.tsx's `setConnection`.
- * Connects the current tab or creates a new worksheet, then sets the tab
+ * Connects the current tab or creates a new saved query, then sets the tab
* mode + batch-query context and flips the aside panel to `SCHEMA`.
*/
export function setConnection(options: {
@@ -68,7 +68,7 @@ export function setConnection(options: {
const tabsState = getSQLEditorTabsState();
const currentTab = tabsState.tabsById.get(tabsState.currentTabId);
- const { maybeUpdateWorksheet, createWorksheet } =
+ const { maybeUpdateSavedQuery, createSavedQuery } =
useSQLEditorStore.getState();
const batchQueryContext: BatchQueryContext = Object.assign(
@@ -79,15 +79,15 @@ export function setConnection(options: {
const createOrUpdate = () => {
if (!newTab && currentTab) {
- return maybeUpdateWorksheet({
+ return maybeUpdateSavedQuery({
tabId: currentTab.id,
- worksheet: currentTab.worksheet,
+ savedQuery: currentTab.savedQuery,
title: currentTab.title,
database: connection.database,
statement: currentTab.statement,
});
}
- return createWorksheet({
+ return createSavedQuery({
database: connection.database,
});
};
diff --git a/frontend/src/modules/sql-editor/components/EditorAction.test.tsx b/frontend/src/modules/sql-editor/components/EditorAction.test.tsx
index c8fdfcf181..a9a07c433d 100644
--- a/frontend/src/modules/sql-editor/components/EditorAction.test.tsx
+++ b/frontend/src/modules/sql-editor/components/EditorAction.test.tsx
@@ -22,10 +22,10 @@ const mocks = vi.hoisted(() => ({
resultRowsLimit: 500,
updateCurrentTab: vi.fn(),
useUIStateStore: vi.fn(),
- getWorksheetByName: vi.fn<(name: string) => unknown>(),
- useWorksheetAndTab: vi.fn(),
+ getSavedQueryByName: vi.fn<(name: string) => unknown>(),
+ useSavedQueryAndTab: vi.fn(),
useConnectionOfCurrentSQLEditorTab: vi.fn(),
- isWorksheetWritableV1: vi.fn(() => true),
+ isSavedQueryWritableV1: vi.fn(() => true),
keyboardShortcutStr: vi.fn((s: string) => s),
emit: vi.fn(),
}));
@@ -41,7 +41,7 @@ vi.mock("@/stores", () => ({
vi.mock("@/stores/app", () => ({
useAppStore: {
getState: () => ({
- getWorksheetByName: mocks.getWorksheetByName,
+ getSavedQueryByName: mocks.getSavedQueryByName,
// `EditorAction.handleRunQuery` records the data-query intro flag via
// the migrated preferences slice. Tests don't assert against this, so a
// bare noop keeps the call surface satisfied.
@@ -50,8 +50,8 @@ vi.mock("@/stores/app", () => ({
},
}));
-vi.mock("@/hooks/useWorksheetAndTab", () => ({
- useWorksheetAndTab: mocks.useWorksheetAndTab,
+vi.mock("@/hooks/useSavedQueryAndTab", () => ({
+ useSavedQueryAndTab: mocks.useSavedQueryAndTab,
}));
vi.mock("@/modules/sql-editor/hooks/useSQLEditorState", () => ({
@@ -72,7 +72,7 @@ vi.mock("@/modules/sql-editor/store/editor", () => ({
}));
vi.mock("@/utils", () => ({
- isWorksheetWritableV1: mocks.isWorksheetWritableV1,
+ isSavedQueryWritableV1: mocks.isSavedQueryWritableV1,
keyboardShortcutStr: mocks.keyboardShortcutStr,
isDev: () => true,
}));
@@ -172,22 +172,22 @@ const renderIntoContainer = (element: ReactElement) => {
};
type SetupOptions = {
- mode?: "WORKSHEET" | "ADMIN";
+ mode?: "SAVED_QUERY" | "ADMIN";
isDisconnected?: boolean;
statement?: string;
status?: "CLEAN" | "DIRTY" | "SAVING";
- worksheet?: string;
+ savedQuery?: string;
engine?: Engine;
table?: string;
};
const setup = (options: SetupOptions = {}) => {
const {
- mode = "WORKSHEET",
+ mode = "SAVED_QUERY",
isDisconnected = false,
statement = "SELECT 1",
status = "DIRTY",
- worksheet,
+ savedQuery,
engine = Engine.POSTGRES,
table,
} = options;
@@ -198,7 +198,7 @@ const setup = (options: SetupOptions = {}) => {
statement,
selectedStatement: "",
status,
- worksheet,
+ savedQuery,
connection: { database: "databases/db1", table },
editorState: { selection: null },
};
@@ -215,12 +215,12 @@ const setup = (options: SetupOptions = {}) => {
const updateCurrentTab = mocks.updateCurrentTab;
mocks.useUIStateStore.mockReturnValue({ saveIntroStateByKey });
- mocks.getWorksheetByName.mockImplementation(() => ({
- name: worksheet ?? "",
+ mocks.getSavedQueryByName.mockImplementation(() => ({
+ name: savedQuery ?? "",
database: "databases/db1",
}));
- mocks.useWorksheetAndTab.mockReturnValue({
- currentSheet: worksheet ? { name: worksheet, title: "sheet" } : undefined,
+ mocks.useSavedQueryAndTab.mockReturnValue({
+ currentSheet: savedQuery ? { name: savedQuery, title: "sheet" } : undefined,
isCreator: false,
isReadOnly: false,
});
@@ -237,7 +237,7 @@ beforeEach(async () => {
mocks.useTranslation.mockReturnValue({
t: (key: string, fallback?: string) => fallback ?? key,
});
- mocks.isWorksheetWritableV1.mockReturnValue(true);
+ mocks.isSavedQueryWritableV1.mockReturnValue(true);
({ EditorAction } = await import("./EditorAction"));
});
@@ -345,7 +345,7 @@ describe("EditorAction", () => {
act(() => {
exitBtn?.click();
});
- expect(updateCurrentTab).toHaveBeenCalledWith({ mode: "WORKSHEET" });
+ expect(updateCurrentTab).toHaveBeenCalledWith({ mode: "SAVED_QUERY" });
unmount();
});
diff --git a/frontend/src/modules/sql-editor/components/EditorAction.tsx b/frontend/src/modules/sql-editor/components/EditorAction.tsx
index b12c0d22de..286789fa02 100644
--- a/frontend/src/modules/sql-editor/components/EditorAction.tsx
+++ b/frontend/src/modules/sql-editor/components/EditorAction.tsx
@@ -8,7 +8,7 @@ import {
PopoverTrigger,
} from "@/components/ui/popover";
import { Tooltip } from "@/components/ui/tooltip";
-import { useWorksheetAndTab } from "@/hooks/useWorksheetAndTab";
+import { useSavedQueryAndTab } from "@/hooks/useSavedQueryAndTab";
import { cn } from "@/lib/utils";
import { useConnectionOfCurrentSQLEditorTab } from "@/modules/sql-editor/hooks/useSQLEditorState";
import { sqlEditorEvents } from "@/modules/sql-editor/model/events";
@@ -22,7 +22,7 @@ import {
import { useAppStore } from "@/stores/app";
import type { SQLEditorQueryParams } from "@/types";
import { Engine } from "@/types/proto-es/v1/common_pb";
-import { isWorksheetWritableV1, keyboardShortcutStr } from "@/utils";
+import { isSavedQueryWritableV1, keyboardShortcutStr } from "@/utils";
import { AdminModeButton } from "./AdminModeButton";
import { ChooserGroup } from "./ChooserGroup";
import { ContainerChooser } from "./ContainerChooser";
@@ -44,7 +44,7 @@ type Props = {
*/
export function EditorAction({ onExecute }: Props) {
const { t } = useTranslation();
- const { currentSheet: currentWorksheet } = useWorksheetAndTab();
+ const { currentSheet: currentSavedQuery } = useSavedQueryAndTab();
const { instance } = useConnectionOfCurrentSQLEditorTab();
const [shareOpen, setShareOpen] = useState(false);
@@ -63,8 +63,8 @@ export function EditorAction({ onExecute }: Props) {
const tabMode = useSQLEditorTabState(
(s) => s.tabsById.get(s.currentTabId)?.mode
);
- const tabWorksheet = useSQLEditorTabState(
- (s) => s.tabsById.get(s.currentTabId)?.worksheet ?? ""
+ const tabSavedQuery = useSQLEditorTabState(
+ (s) => s.tabsById.get(s.currentTabId)?.savedQuery ?? ""
);
const tabConnectionTable = useSQLEditorTabState(
(s) => s.tabsById.get(s.currentTabId)?.connection.table ?? ""
@@ -73,7 +73,7 @@ export function EditorAction({ onExecute }: Props) {
const resultRowsLimit = useSQLEditorEditorState((s) => s.resultRowsLimit);
const isAdminMode = tabMode === "ADMIN";
- const showSheetsFeature = tabMode === "WORKSHEET";
+ const showSheetsFeature = tabMode === "SAVED_QUERY";
const isEmptyStatement = !currentTab || tabStatement === "";
const isCosmosDBWithoutContainer =
instance.engine === Engine.COSMOSDB && !tabConnectionTable;
@@ -86,16 +86,16 @@ export function EditorAction({ onExecute }: Props) {
})();
const canWriteSheet = (() => {
- if (!tabWorksheet) return false;
- const sheet = useAppStore.getState().getWorksheetByName(tabWorksheet);
- return sheet ? isWorksheetWritableV1(sheet) : false;
+ if (!tabSavedQuery) return false;
+ const sheet = useAppStore.getState().getSavedQueryByName(tabSavedQuery);
+ return sheet ? isSavedQueryWritableV1(sheet) : false;
})();
const allowSave = (() => {
if (!showSheetsFeature || !currentTab) return false;
- if (tabWorksheet) {
+ if (tabSavedQuery) {
if (!canWriteSheet) return false;
- const sheet = useAppStore.getState().getWorksheetByName(tabWorksheet);
+ const sheet = useAppStore.getState().getSavedQueryByName(tabSavedQuery);
if (sheet && sheet.database !== currentTab.connection.database) {
return true;
}
@@ -109,7 +109,7 @@ export function EditorAction({ onExecute }: Props) {
if (!currentTab) return false;
if (tabStatus !== "CLEAN") return false;
if (isEmptyStatement || isDisconnected) return false;
- if (tabWorksheet && !canWriteSheet) return false;
+ if (tabSavedQuery && !canWriteSheet) return false;
return true;
})();
@@ -135,7 +135,7 @@ export function EditorAction({ onExecute }: Props) {
const exitAdminMode = () => {
// Inlined to avoid pulling `@/types` (monaco-editor transitive) into the
// React bundle. Matches `DEFAULT_SQL_EDITOR_TAB_MODE` in `@/types/sqlEditor/tab`.
- getSQLEditorTabsState().updateCurrentTab({ mode: "WORKSHEET" });
+ getSQLEditorTabsState().updateCurrentTab({ mode: "SAVED_QUERY" });
};
const handleClickSave = () => {
@@ -234,7 +234,7 @@ export function EditorAction({ onExecute }: Props) {
/>
</Tooltip>
<PopoverContent align="end" sideOffset={4}>
- <SharePopoverBody worksheet={currentWorksheet} />
+ <SharePopoverBody savedQuery={currentSavedQuery} />
</PopoverContent>
</Popover>
</>
diff --git a/frontend/src/modules/sql-editor/components/FolderForm.test.tsx b/frontend/src/modules/sql-editor/components/FolderForm.test.tsx
index cc1a85af74..752a373951 100644
--- a/frontend/src/modules/sql-editor/components/FolderForm.test.tsx
+++ b/frontend/src/modules/sql-editor/components/FolderForm.test.tsx
@@ -2,7 +2,7 @@ import type { ReactElement } from "react";
import { act } from "react";
import { createRoot } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
-import type { WorksheetFolderNode } from "@/modules/sql-editor/model/Sheet";
+import type { SavedQueryFolderNode } from "@/modules/sql-editor/model/Sheet";
(
globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
@@ -39,7 +39,7 @@ vi.mock("@/hooks/useClickOutside", () => ({
type TreeDataNodeLike = {
id: string;
- data: WorksheetFolderNode;
+ data: SavedQueryFolderNode;
children?: TreeDataNodeLike[];
};
@@ -155,8 +155,8 @@ vi.mock("./TreeNodePrefix", () => ({
const makeFolderNode = (
key: string,
- children: WorksheetFolderNode[] = []
-): WorksheetFolderNode => ({
+ children: SavedQueryFolderNode[] = []
+): SavedQueryFolderNode => ({
key,
label: key.split("/").slice(-1)[0],
editable: true,
@@ -164,7 +164,7 @@ const makeFolderNode = (
empty: children.length === 0,
});
-const makeLoadMoreNode = (key: string): WorksheetFolderNode => ({
+const makeLoadMoreNode = (key: string): SavedQueryFolderNode => ({
key,
label: "Load more",
editable: false,
@@ -183,7 +183,7 @@ const setupDefaultMocks = () => {
]);
// The migrated `useSheetContextByView` returns plain values:
- // `folderTree` is a WorksheetFolderNode (not a Vue ref) and
+ // `folderTree` is a SavedQueryFolderNode (not a Vue ref) and
// `folderContext.rootPath` is a plain string.
const viewContext = {
folderTree: rootNode,
diff --git a/frontend/src/modules/sql-editor/components/FolderForm.tsx b/frontend/src/modules/sql-editor/components/FolderForm.tsx
index ce2e382a1f..d1f79f3dbe 100644
--- a/frontend/src/modules/sql-editor/components/FolderForm.tsx
+++ b/frontend/src/modules/sql-editor/components/FolderForm.tsx
@@ -8,8 +8,8 @@ import type { TreeDataNode } from "@/components/ui/tree";
import { Tree } from "@/components/ui/tree";
import { cn } from "@/lib/utils";
import {
+ type SavedQueryFolderNode,
useSheetContextByView,
- type WorksheetFolderNode,
} from "@/modules/sql-editor/model/Sheet";
import { TreeNodePrefix } from "./TreeNodePrefix";
@@ -20,8 +20,8 @@ type Props = {
};
function toTreeData(
- node: WorksheetFolderNode
-): TreeDataNode<WorksheetFolderNode> {
+ node: SavedQueryFolderNode
+): TreeDataNode<SavedQueryFolderNode> {
return {
id: node.key,
data: node,
@@ -106,7 +106,7 @@ export function FolderForm({
? [toTreeData(folderTree)]
: folderTree.children.filter((child) => !child.loadMore).map(toTreeData);
- const searchMatch = (node: TreeDataNode<WorksheetFolderNode>) => {
+ const searchMatch = (node: TreeDataNode<SavedQueryFolderNode>) => {
if (!folderPath) return true;
return node.data.key.includes(folderPath);
};
@@ -140,7 +140,7 @@ export function FolderForm({
style={{ width: "var(--anchor-width)" }}
className="p-1"
>
- <Tree<WorksheetFolderNode>
+ <Tree<SavedQueryFolderNode>
data={treeData}
selectedIds={folderPath ? [folderPath] : []}
expandedIds={includeRoot ? [rootPath] : undefined}
diff --git a/frontend/src/modules/sql-editor/components/GutterBar.test.tsx b/frontend/src/modules/sql-editor/components/GutterBar.test.tsx
index 3e687e08c7..7769e6ce4a 100644
--- a/frontend/src/modules/sql-editor/components/GutterBar.test.tsx
+++ b/frontend/src/modules/sql-editor/components/GutterBar.test.tsx
@@ -17,7 +17,7 @@ const mocks = vi.hoisted(() => ({
},
// New zustand store.
state: {
- asidePanelTab: "WORKSHEET" as string,
+ asidePanelTab: "SAVED_QUERY" as string,
},
setAsidePanelTab: vi.fn(),
routerResolve: vi.fn(() => ({ href: "/project/test-project" })),
@@ -88,7 +88,7 @@ beforeEach(async () => {
vi.clearAllMocks();
mocks.project = "projects/test";
mocks.projectData = { allowJustInTimeAccess: false };
- mocks.state.asidePanelTab = "WORKSHEET";
+ mocks.state.asidePanelTab = "SAVED_QUERY";
mocks.routerResolve.mockReturnValue({ href: "/workspace/home" });
({ GutterBar } = await import("./GutterBar"));
});
@@ -131,7 +131,7 @@ describe("GutterBar", () => {
const { render, unmount } = renderIntoContainer(<GutterBar />);
render();
- expect(mocks.setAsidePanelTab).toHaveBeenCalledWith("WORKSHEET");
+ expect(mocks.setAsidePanelTab).toHaveBeenCalledWith("SAVED_QUERY");
unmount();
});
diff --git a/frontend/src/modules/sql-editor/components/GutterBar.tsx b/frontend/src/modules/sql-editor/components/GutterBar.tsx
index ce2c3eb843..eafd0a6f65 100644
--- a/frontend/src/modules/sql-editor/components/GutterBar.tsx
+++ b/frontend/src/modules/sql-editor/components/GutterBar.tsx
@@ -7,7 +7,7 @@ import { TabItem } from "./TabItem";
/**
* Left gutter of the SQL Editor aside panel. Shows 4 tab buttons
- * (WORKSHEET, SCHEMA, HISTORY, and optionally ACCESS when the current
+ * (SAVED_QUERY, SCHEMA, HISTORY, and optionally ACCESS when the current
* project allows JIT).
*
* Replaces frontend/src/views/sql-editor/AsidePanel/GutterBar/GutterBar.vue.
@@ -22,7 +22,7 @@ export function GutterBar() {
useEffect(() => {
if (asidePanelTab === "ACCESS" && !project?.allowJustInTimeAccess) {
- setAsidePanelTab("WORKSHEET");
+ setAsidePanelTab("SAVED_QUERY");
}
}, [asidePanelTab, project?.allowJustInTimeAccess, setAsidePanelTab]);
@@ -33,7 +33,10 @@ export function GutterBar() {
return (
<div className="h-full flex flex-col items-stretch justify-between overflow-hidden text-sm p-1">
<div className="flex flex-col gap-y-1">
- <TabItem tab="WORKSHEET" onClick={() => handleClickTab("WORKSHEET")} />
+ <TabItem
+ tab="SAVED_QUERY"
+ onClick={() => handleClickTab("SAVED_QUERY")}
+ />
<TabItem tab="SCHEMA" onClick={() => handleClickTab("SCHEMA")} />
<TabItem tab="HISTORY" onClick={() => handleClickTab("HISTORY")} />
{project?.allowJustInTimeAccess && (
diff --git a/frontend/src/modules/sql-editor/components/OpenAIButton.test.tsx b/frontend/src/modules/sql-editor/components/OpenAIButton.test.tsx
index 2b36d57bfe..1fa5547357 100644
--- a/frontend/src/modules/sql-editor/components/OpenAIButton.test.tsx
+++ b/frontend/src/modules/sql-editor/components/OpenAIButton.test.tsx
@@ -13,7 +13,7 @@ const mocks = vi.hoisted(() => ({
// Per-test controllable tab-derived state.
tabState: {
isDisconnected: false,
- currentMode: "WORKSHEET" as string | undefined,
+ currentMode: "SAVED_QUERY" as string | undefined,
},
// New zustand state mirror.
state: { showAIPanel: false },
@@ -210,7 +210,7 @@ const renderIntoContainer = (element: ReactElement) => {
};
};
-// Default state: connected, worksheet mode, AI enabled, showAIPanel=false
+// Default state: connected, saved query mode, AI enabled, showAIPanel=false
type VueStateValues = {
isDisconnected: boolean;
currentMode: string | undefined;
@@ -222,7 +222,7 @@ type VueStateValues = {
const setupDefaultMocks = (overrides: Partial<VueStateValues> = {}) => {
const values: VueStateValues = {
isDisconnected: false,
- currentMode: "WORKSHEET",
+ currentMode: "SAVED_QUERY",
showAIPanel: false,
instance: { engine: Engine.POSTGRES },
openAIEnabled: true,
@@ -267,7 +267,7 @@ describe("OpenAIButton", () => {
unmount();
});
- test("renders nothing when not in WORKSHEET mode", () => {
+ test("renders nothing when not in SAVED_QUERY mode", () => {
setupDefaultMocks({ currentMode: "ADMIN" });
const { container, render, unmount } = renderIntoContainer(
<OpenAIButton />
diff --git a/frontend/src/modules/sql-editor/components/OpenAIButton.tsx b/frontend/src/modules/sql-editor/components/OpenAIButton.tsx
index 87c714f805..e092c91b44 100644
--- a/frontend/src/modules/sql-editor/components/OpenAIButton.tsx
+++ b/frontend/src/modules/sql-editor/components/OpenAIButton.tsx
@@ -47,7 +47,7 @@ type Props = {
/**
* Replaces frontend/src/views/sql-editor/EditorCommon/OpenAIButton/*.vue.
- * Shows an AI-assistant toggle when the editor is connected + in worksheet
+ * Shows an AI-assistant toggle when the editor is connected + in saved query
* mode. Clicking the button toggles the AI panel; the attached dropdown
* offers shortcuts that seed the chat with a prompt.
*/
@@ -76,7 +76,7 @@ export function OpenAIButton({ actions, statement, size = "default" }: Props) {
const [menuOpen, setMenuOpen] = useState(false);
- if (isDisconnected || currentMode !== "WORKSHEET") {
+ if (isDisconnected || currentMode !== "SAVED_QUERY") {
return null;
}
diff --git a/frontend/src/modules/sql-editor/components/Panels/Panels.tsx b/frontend/src/modules/sql-editor/components/Panels/Panels.tsx
index 668b1927ad..dcf9178656 100644
--- a/frontend/src/modules/sql-editor/components/Panels/Panels.tsx
+++ b/frontend/src/modules/sql-editor/components/Panels/Panels.tsx
@@ -56,7 +56,7 @@ const AIPaneFallback = () => (
* React port of `frontend/src/views/sql-editor/EditorPanel/Panels/Panels.vue`.
*
* The host shell beneath `<EditorPanel>`. Two render modes:
- * - `viewState.view === "CODE"` (or no viewState) — shows the worksheet
+ * - `viewState.view === "CODE"` (or no viewState) — shows the saved query
* editor (`<StandardPanel>`) or terminal (`<TerminalPanel>`) based on
* the active tab's mode. The Vue version did this selection in
* `EditorPanel.vue` and passed the result into `<Panels>` via a named
@@ -84,7 +84,7 @@ export function Panels() {
// Subscribe to `mode` as its own primitive — Pinia's tabStore mutates
// the tab proxy in place via `Object.assign`, so `() => tabStore
// .currentTab` only fires Vue's watch on tab-switches (proxy
- // reference changes), not on `mode` flipping between "WORKSHEET" and
+ // reference changes), not on `mode` flipping between "SAVED_QUERY" and
// "ADMIN" within the same tab. Without this, clicking the admin-mode
// button doesn't swap to the `TerminalPanel`.
const tabMode = useSQLEditorTabState(
@@ -163,7 +163,7 @@ export function Panels() {
}, [tabId, databaseMetadata, currentSchema, setSchema]);
const codePanel = useMemo(() => {
- if (!tab || tabMode === "WORKSHEET") {
+ if (!tab || tabMode === "SAVED_QUERY") {
return <StandardPanel key={`standard-${tab?.id ?? "default"}`} />;
}
if (tabMode === "ADMIN") {
diff --git a/frontend/src/modules/sql-editor/components/QueryContextSettingPopover.test.tsx b/frontend/src/modules/sql-editor/components/QueryContextSettingPopover.test.tsx
index 8ab8ce096a..f7d9461ec6 100644
--- a/frontend/src/modules/sql-editor/components/QueryContextSettingPopover.test.tsx
+++ b/frontend/src/modules/sql-editor/components/QueryContextSettingPopover.test.tsx
@@ -168,7 +168,7 @@ beforeEach(async () => {
mocks.getInstanceResource.mockReturnValue(mockInstance);
mocks.orderBy.mockImplementation((arr: unknown[]) => arr);
- setTabMode("WORKSHEET");
+ setTabMode("SAVED_QUERY");
mocks.editorState = {
project: "projects/p1",
resultRowsLimit: 1000,
diff --git a/frontend/src/modules/sql-editor/components/ResultView/ResultView.tsx b/frontend/src/modules/sql-editor/components/ResultView/ResultView.tsx
index af98dbd87d..0921aede71 100644
--- a/frontend/src/modules/sql-editor/components/ResultView/ResultView.tsx
+++ b/frontend/src/modules/sql-editor/components/ResultView/ResultView.tsx
@@ -44,7 +44,7 @@ export interface ResultViewProps {
resultSet?: SQLResultSetV1;
loading?: boolean;
// Compact layout (fixed-height result body) for the terminal / admin panel.
- // The worksheet panel leaves this false to keep the flex-grow layout.
+ // The saved query panel leaves this false to keep the flex-grow layout.
compact?: boolean;
}
diff --git a/frontend/src/modules/sql-editor/components/ResultView/SingleResultView.tsx b/frontend/src/modules/sql-editor/components/ResultView/SingleResultView.tsx
index 36dc2f74f5..cab7191c2a 100644
--- a/frontend/src/modules/sql-editor/components/ResultView/SingleResultView.tsx
+++ b/frontend/src/modules/sql-editor/components/ResultView/SingleResultView.tsx
@@ -97,7 +97,7 @@ export interface SingleResultViewProps {
// "Request export" affordance when the policy disables direct export.
requestExportSlot?: ReactNode;
// Compact layout (fixed-height, non-growing body) used by the terminal /
- // admin result panel. Defaults to the flex-grow worksheet layout.
+ // admin result panel. Defaults to the flex-grow saved query layout.
compact?: boolean;
}
diff --git a/frontend/src/modules/sql-editor/components/SQLEditorHeader.test.tsx b/frontend/src/modules/sql-editor/components/SQLEditorHeader.test.tsx
index 555ffc3c02..30b08c4f2e 100644
--- a/frontend/src/modules/sql-editor/components/SQLEditorHeader.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SQLEditorHeader.test.tsx
@@ -57,7 +57,7 @@ vi.mock("react-i18next", () => ({
t: (key: string) =>
({
"sql-editor.self": "SQL Editor",
- "sql-editor.tab.unsaved-worksheet": "Unsaved worksheet.",
+ "sql-editor.tab.unsaved-changes": "You have unsaved changes.",
})[key] ?? key,
}),
}));
@@ -264,7 +264,7 @@ describe("SQLEditorHeader", () => {
render();
expect(mocks.breadcrumbProps?.onBeforeSwitchWorkspace?.()).toBe(false);
- expect(window.alert).toHaveBeenCalledWith("Unsaved worksheet.");
+ expect(window.alert).toHaveBeenCalledWith("You have unsaved changes.");
unmount();
});
diff --git a/frontend/src/modules/sql-editor/components/SQLEditorHeader.tsx b/frontend/src/modules/sql-editor/components/SQLEditorHeader.tsx
index a5d75054c5..fb3794a741 100644
--- a/frontend/src/modules/sql-editor/components/SQLEditorHeader.tsx
+++ b/frontend/src/modules/sql-editor/components/SQLEditorHeader.tsx
@@ -84,7 +84,7 @@ export function SQLEditorHeader() {
for (const persisted of tabsState.openTmpTabList) {
const tab = tabsState.tabsById.get(persisted.id);
if (tab && tab.status !== "CLEAN") {
- window.alert(t("sql-editor.tab.unsaved-worksheet"));
+ window.alert(t("sql-editor.tab.unsaved-changes"));
return false;
}
}
diff --git a/frontend/src/modules/sql-editor/components/SQLEditorLayout.tsx b/frontend/src/modules/sql-editor/components/SQLEditorLayout.tsx
index 1df0392d4f..8ccb692213 100644
--- a/frontend/src/modules/sql-editor/components/SQLEditorLayout.tsx
+++ b/frontend/src/modules/sql-editor/components/SQLEditorLayout.tsx
@@ -37,7 +37,7 @@ function SQLEditorThemeRoot({ children }: Readonly<{ children: ReactNode }>) {
* - workspace-scope common data via `useEnsureWorkspaceCommonData()` —
* the same hook DashboardFrameShell uses. Idempotent loaders make it
* safe to call from every top-level shell.
- * - `useSQLEditorAutoSave()` — the 2-second debounced worksheet
+ * - `useSQLEditorAutoSave()` — the 2-second debounced saved query
* auto-save extracted from the legacy `provideSQLEditorContext()`.
* - the `<SQLEditorRouteShell>` once `ready` flips true.
*/
diff --git a/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.test.tsx b/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.test.tsx
index 3fe79824d2..1eb9f202f5 100644
--- a/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.test.tsx
@@ -18,7 +18,7 @@ const mocks = vi.hoisted(() => {
addTab: vi.fn((payload: Partial<SQLEditorTab> = {}) => {
const tab = {
id: "tab-1",
- worksheet: "",
+ savedQuery: "",
connection: {
instance: "",
database: "",
@@ -52,8 +52,8 @@ const mocks = vi.hoisted(() => {
fetchInstance: vi.fn<
(name: string) => Promise<{ name: string } | undefined>
>(async (name: string) => ({ name })),
- getWorksheetByName: vi.fn(),
- getOrFetchWorksheetByName: vi.fn(),
+ getSavedQueryByName: vi.fn(),
+ getOrFetchSavedQueryByName: vi.fn(),
searchProjects: vi.fn(),
beforeEach: vi.fn(() => vi.fn()),
navigateReplace: vi.fn(),
@@ -144,8 +144,8 @@ vi.mock("@/stores/app", () => ({
getState: () => ({
getOrFetchDatabaseByName: mocks.getOrFetchDatabaseByName,
fetchInstance: mocks.fetchInstance,
- getWorksheetByName: mocks.getWorksheetByName,
- getOrFetchWorksheetByName: mocks.getOrFetchWorksheetByName,
+ getSavedQueryByName: mocks.getSavedQueryByName,
+ getOrFetchSavedQueryByName: mocks.getOrFetchSavedQueryByName,
searchProjects: mocks.searchProjects,
serverInfo: {
defaultProject: "projects/proj1",
@@ -173,7 +173,7 @@ vi.mock("@/modules/sql-editor/store", () => ({
vi.mock("@/utils", async (importOriginal) => ({
...(await importOriginal<typeof import("@/utils")>()),
- isWorksheetReadableV1: vi.fn(() => true),
+ isSavedQueryReadableV1: vi.fn(() => true),
}));
vi.mock("@/modules/sql-editor/store/editor", () => ({
@@ -222,7 +222,7 @@ beforeEach(() => {
(payload: Partial<SQLEditorTab> = {}) => {
const tab = {
id: "tab-1",
- worksheet: "",
+ savedQuery: "",
connection: {
instance: "",
database: "",
@@ -239,11 +239,11 @@ beforeEach(() => {
project: "projects/proj1",
}));
mocks.fetchInstance.mockImplementation(async (name: string) => ({ name }));
- mocks.getWorksheetByName.mockImplementation((name: string) => ({
+ mocks.getSavedQueryByName.mockImplementation((name: string) => ({
name,
project: "projects/proj1",
}));
- mocks.getOrFetchWorksheetByName.mockImplementation(async (name: string) => ({
+ mocks.getOrFetchSavedQueryByName.mockImplementation(async (name: string) => ({
name,
project: "projects/proj1",
database: "instances/inst1/databases/db1",
@@ -301,7 +301,7 @@ describe("SQLEditorRouteShell", () => {
schema: "public",
table: "users",
},
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
});
expect(mocks.navigateReplace).toHaveBeenCalledWith({
name: "sql-editor.database",
@@ -343,7 +343,7 @@ describe("SQLEditorRouteShell", () => {
schema: "public",
table: "users",
},
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
});
expect(mocks.navigateReplace).toHaveBeenCalledWith({
name: "sql-editor.database",
@@ -384,7 +384,7 @@ describe("SQLEditorRouteShell", () => {
schema: "public",
table: "users",
},
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
});
unmount();
@@ -424,7 +424,7 @@ describe("SQLEditorRouteShell", () => {
schema: "public",
table: "users",
},
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
});
expect(mocks.navigateReplace).toHaveBeenCalledWith({
name: "sql-editor.database",
@@ -484,7 +484,7 @@ describe("SQLEditorRouteShell", () => {
instance: parent,
database: "",
},
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
});
expect(mocks.navigateReplace).toHaveBeenCalledWith({
name: "sql-editor.instance",
@@ -522,7 +522,7 @@ describe("SQLEditorRouteShell", () => {
schema: "public",
table: "users",
},
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
});
unmount();
@@ -533,7 +533,7 @@ describe("SQLEditorRouteShell", () => {
(payload: Partial<SQLEditorTab> = {}) =>
({
id: "tab-pending",
- worksheet: "",
+ savedQuery: "",
connection: {
instance: "",
database: "",
@@ -557,7 +557,7 @@ describe("SQLEditorRouteShell", () => {
schema: "public",
table: "users",
},
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
});
expect(mocks.navigateReplace).not.toHaveBeenCalledWith({
name: "sql-editor.project",
@@ -595,7 +595,7 @@ describe("SQLEditorRouteShell", () => {
test("updates a stale database URL when the active tab is disconnected", async () => {
mocks.tabsState.tabsById.set("tab-blank", {
id: "tab-blank",
- worksheet: "",
+ savedQuery: "",
connection: {
instance: "",
database: "",
@@ -606,7 +606,7 @@ describe("SQLEditorRouteShell", () => {
(payload: Partial<SQLEditorTab> = {}) => {
const tab = {
id: "tab-from-route",
- worksheet: "",
+ savedQuery: "",
connection: {
instance: "",
database: "",
@@ -637,13 +637,13 @@ describe("SQLEditorRouteShell", () => {
unmount();
});
- test("seeds worksheet route tabs with schema and table from the URL", async () => {
+ test("seeds saved query route tabs with schema and table from the URL", async () => {
mocks.renderRoute = {
...mocks.renderRoute,
- name: "sql-editor.worksheet",
+ name: "sql-editor.saved-query",
params: {
project: "proj1",
- sheet: "sheet1",
+ savedQuery: "sheet1",
},
query: {
schema: "public",
@@ -653,10 +653,10 @@ describe("SQLEditorRouteShell", () => {
};
mocks.currentRoute = {
...mocks.currentRoute,
- name: "sql-editor.worksheet",
+ name: "sql-editor.saved-query",
params: {
project: "proj1",
- sheet: "sheet1",
+ savedQuery: "sheet1",
},
query: {
schema: "public",
@@ -681,7 +681,7 @@ describe("SQLEditorRouteShell", () => {
schema: "public",
table: "SUPPORDERS_VIS.items",
},
- worksheet: "projects/proj1/worksheets/sheet1",
+ savedQuery: "projects/proj1/savedQueries/sheet1",
title: undefined,
statement: "select 1",
status: "CLEAN",
@@ -690,7 +690,7 @@ describe("SQLEditorRouteShell", () => {
unmount();
});
- test("keeps schema and table query parameters when syncing worksheet tabs", async () => {
+ test("keeps schema and table query parameters when syncing saved query tabs", async () => {
mocks.renderRoute = {
...mocks.renderRoute,
name: "sql-editor.project",
@@ -709,9 +709,9 @@ describe("SQLEditorRouteShell", () => {
query: {},
requiredPermissions: [],
};
- mocks.tabsState.tabsById.set("tab-worksheet", {
- id: "tab-worksheet",
- worksheet: "projects/proj1/worksheets/sheet1",
+ mocks.tabsState.tabsById.set("tab-savedQuery", {
+ id: "tab-savedQuery",
+ savedQuery: "projects/proj1/savedQueries/sheet1",
connection: {
instance: "instances/inst1",
database: "instances/inst1/databases/db1",
@@ -719,7 +719,7 @@ describe("SQLEditorRouteShell", () => {
table: "SUPPORDERS_VIS.items",
},
} as SQLEditorTab);
- mocks.tabsState.currentTabId = "tab-worksheet";
+ mocks.tabsState.currentTabId = "tab-savedQuery";
const { unmount } = renderShell();
@@ -730,10 +730,10 @@ describe("SQLEditorRouteShell", () => {
});
expect(mocks.navigateReplace).toHaveBeenCalledWith({
- name: "sql-editor.worksheet",
+ name: "sql-editor.saved-query",
params: {
project: "proj1",
- sheet: "sheet1",
+ savedQuery: "sheet1",
},
query: {
table: "SUPPORDERS_VIS.items",
diff --git a/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.tsx b/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.tsx
index 2af2948748..4e972047e6 100644
--- a/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.tsx
+++ b/frontend/src/modules/sql-editor/components/SQLEditorRouteShell.tsx
@@ -9,7 +9,7 @@ import {
SQL_EDITOR_INSTANCE_MODULE,
SQL_EDITOR_PROJECT_MODULE,
SQL_EDITOR_QUERY_HISTORY_MODULE,
- SQL_EDITOR_WORKSHEET_MODULE,
+ SQL_EDITOR_SAVED_QUERY_MODULE,
} from "@/app/router/handles";
import {
PermissionDeniedFallback,
@@ -17,7 +17,7 @@ import {
usePermissionDataReady,
} from "@/components/ComponentPermissionGuard";
import { useAppProject } from "@/hooks/useAppProject";
-import { extractWorksheetConnection } from "@/lib/sqlEditorConnection";
+import { extractSavedQueryConnection } from "@/lib/sqlEditorConnection";
import { useClampResultRowsLimitToPolicy } from "@/modules/sql-editor/hooks/useSQLEditorState";
import { migrateLegacyCache } from "@/modules/sql-editor/legacy/migration";
import { sqlEditorEvents } from "@/modules/sql-editor/model/events";
@@ -45,10 +45,10 @@ import {
extractDatabaseResourceName,
extractInstanceResourceName,
extractProjectResourceName,
- extractWorksheetID,
+ extractSavedQueryID,
getDefaultPagination,
getSheetStatement,
- isWorksheetReadableV1,
+ isSavedQueryReadableV1,
storageKeySqlEditorSidebarTab,
} from "@/utils";
import { SQLEditorHomePage } from "./SQLEditorHomePage";
@@ -56,14 +56,14 @@ import { SQLEditorHomePage } from "./SQLEditorHomePage";
// Route-name set for the unsaved-changes leave guard. Vue Router's
// `beforeEach` is global, so this set scopes the prompt to navigations
// that actually leave the SQL Editor — internal SQL Editor route sync
-// (`navigate.replace(...)` between worksheet/database/instance modules)
+// (`navigate.replace(...)` between saved query/database/instance modules)
// must not trigger it.
const SQL_EDITOR_MODULES = new Set<string>([
SQL_EDITOR_HOME_MODULE,
SQL_EDITOR_PROJECT_MODULE,
SQL_EDITOR_INSTANCE_MODULE,
SQL_EDITOR_DATABASE_MODULE,
- SQL_EDITOR_WORKSHEET_MODULE,
+ SQL_EDITOR_SAVED_QUERY_MODULE,
SQL_EDITOR_QUERY_HISTORY_MODULE,
]);
@@ -82,7 +82,7 @@ const linkedDraftFingerprint = (tab: {
const ASIDE_PANEL_TABS: readonly AsidePanelTab[] = [
"SCHEMA",
- "WORKSHEET",
+ "SAVED_QUERY",
"HISTORY",
"ACCESS",
];
@@ -94,8 +94,8 @@ const ASIDE_PANEL_TABS: readonly AsidePanelTab[] = [
* - on mount, resolves the active project from URL params/query and
* `editorStore.storedLastViewedProject`, falling back to the first
* accessible project, then sets up the per-project tab list.
- * - hydrates the active tab from the URL: opens the worksheet for
- * `/projects/:project/sheets/:sheet`, or opens an instance/database
+ * - hydrates the active tab from the URL: opens the saved query for
+ * `/projects/:project/savedQueries/:savedQuery`, or opens an instance/database
* connection for the `instances/:instance/databases/:database` form.
* - keeps the URL synced with the active tab's connection (Pinia →
* `router.replace`), so reload restores the right surface.
@@ -196,24 +196,24 @@ export function SQLEditorRouteShell() {
return getSQLEditorEditorState().project;
};
- const switchWorksheet = async (sheetName: string) => {
+ const switchSavedQuery = async (sheetName: string) => {
const tabsState = getSQLEditorTabsState();
const openedSheetTab = Array.from(tabsState.tabsById.values()).find(
- (t) => t.worksheet === sheetName
+ (t) => t.savedQuery === sheetName
);
const sheet = await useAppStore
.getState()
- .getOrFetchWorksheetByName(sheetName);
+ .getOrFetchSavedQueryByName(sheetName);
if (!sheet) {
if (openedSheetTab) {
tabsState.updateTab(openedSheetTab.id, {
- worksheet: "",
+ savedQuery: "",
status: "DIRTY",
});
}
return false;
}
- if (!isWorksheetReadableV1(sheet)) {
+ if (!isSavedQueryReadableV1(sheet)) {
useAppStore.getState().notify({
module: "bytebase",
style: "CRITICAL",
@@ -221,7 +221,7 @@ export function SQLEditorRouteShell() {
});
return false;
}
- const connection = await extractWorksheetConnection(sheet);
+ const connection = await extractSavedQueryConnection(sheet);
const schema = route.query.schema;
const table = route.query.table;
if (typeof schema === "string" && schema) {
@@ -234,7 +234,7 @@ export function SQLEditorRouteShell() {
tabsState.addTab({
id: openedSheetTab?.id,
connection,
- worksheet: sheet.name,
+ savedQuery: sheet.name,
title: sheet.title,
statement: getSheetStatement(sheet),
status: "CLEAN",
@@ -244,11 +244,13 @@ export function SQLEditorRouteShell() {
const prepareSheet = async () => {
const projectId = route.params.project;
- const sheetId = route.params.sheet;
+ const sheetId = route.params.savedQuery;
if (typeof projectId !== "string" || !projectId) return false;
if (typeof sheetId !== "string" || !sheetId) return false;
await maybeSwitchProject(`projects/${projectId}`);
- return await switchWorksheet(`projects/${projectId}/worksheets/${sheetId}`);
+ return await switchSavedQuery(
+ `projects/${projectId}/savedQueries/${sheetId}`
+ );
};
const prepareConnectionParams = async () => {
@@ -421,7 +423,7 @@ export function SQLEditorRouteShell() {
// The dependency array does the multi-source coalescing.
const projName = useSQLEditorEditorState((s) => s.project);
const sheetName = useSQLEditorTabState(
- (s) => s.tabsById.get(s.currentTabId)?.worksheet
+ (s) => s.tabsById.get(s.currentTabId)?.savedQuery
);
const instanceName = useSQLEditorTabState(
(s) => s.tabsById.get(s.currentTabId)?.connection.instance
@@ -487,7 +489,7 @@ export function SQLEditorRouteShell() {
}
if (vals.sheetName) {
- const sheet = useAppStore.getState().getWorksheetByName(vals.sheetName);
+ const sheet = useAppStore.getState().getSavedQueryByName(vals.sheetName);
if (sheet) {
if (vals.schema) query.schema = vals.schema;
if (vals.table) {
@@ -495,17 +497,17 @@ export function SQLEditorRouteShell() {
query.schema = vals.schema ?? "";
}
await navigate.replace({
- name: SQL_EDITOR_WORKSHEET_MODULE,
+ name: SQL_EDITOR_SAVED_QUERY_MODULE,
params: {
project: extractProjectResourceName(sheet.project),
- sheet: extractWorksheetID(sheet.name),
+ savedQuery: extractSavedQueryID(sheet.name),
},
query,
});
return;
} else {
tabsState.updateCurrentTab({
- worksheet: "",
+ savedQuery: "",
status: "DIRTY",
});
}
@@ -589,7 +591,7 @@ export function SQLEditorRouteShell() {
}, [linkedQueryHistory, linkedQueryHistoryBaseline, linkedTabFingerprint]);
// Running a query consumes the deep-link context — drop the "Opened from
- // link" banner on the first execution (worksheet or terminal).
+ // link" banner on the first execution (saved query or terminal).
useEffect(() => {
const off = sqlEditorEvents.on("query-executed", () => {
if (useSQLEditorStore.getState().linkedQueryHistory) {
@@ -626,7 +628,7 @@ export function SQLEditorRouteShell() {
return;
}
- let stored: AsidePanelTab = "WORKSHEET";
+ let stored: AsidePanelTab = "SAVED_QUERY";
try {
const raw = window.localStorage.getItem(
storageKeySqlEditorSidebarTab(project)
@@ -646,7 +648,9 @@ export function SQLEditorRouteShell() {
const panelQuery = router.currentRoute.value.query.panel;
if (typeof panelQuery === "string" && panelQuery) {
- const tab = panelQuery.toUpperCase() as AsidePanelTab;
+ const raw = panelQuery.toUpperCase();
+ // Pre-rename links used ?panel=worksheet.
+ const tab = (raw === "WORKSHEET" ? "SAVED_QUERY" : raw) as AsidePanelTab;
setAsidePanelTab(ASIDE_PANEL_TABS.includes(tab) ? tab : stored);
} else {
setAsidePanelTab(stored);
@@ -678,7 +682,7 @@ export function SQLEditorRouteShell() {
useEffect(() => {
const dirtyMsg = () =>
- `${t("sql-editor.tab.unsaved-worksheet")} ${t("common.leave-without-saving")}`;
+ `${t("sql-editor.tab.unsaved-changes")} ${t("common.leave-without-saving")}`;
const findDirtyTab = () => {
const tabsState = getSQLEditorTabsState();
for (const persisted of tabsState.openTmpTabList) {
diff --git a/frontend/src/modules/sql-editor/components/SaveSheetModal.test.tsx b/frontend/src/modules/sql-editor/components/SaveSheetModal.test.tsx
index 727d66a3bc..56ed46c119 100644
--- a/frontend/src/modules/sql-editor/components/SaveSheetModal.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SaveSheetModal.test.tsx
@@ -14,16 +14,16 @@ const eventHandlers: Record<string, (payload: unknown) => void> = {};
const mocks = vi.hoisted(() => ({
useTranslation: vi.fn(() => ({ t: (key: string) => key })),
appStore: {
- getWorksheetByName: vi.fn(),
+ getSavedQueryByName: vi.fn(),
},
- editorWorksheetStore: {
+ editorSavedQueryStore: {
abortAutoSave: vi.fn(),
- maybeUpdateWorksheet: vi.fn().mockResolvedValue(undefined),
- createWorksheet: vi.fn().mockResolvedValue(undefined),
+ maybeUpdateSavedQuery: vi.fn().mockResolvedValue(undefined),
+ createSavedQuery: vi.fn().mockResolvedValue(undefined),
},
sheetContext: {
- getPwdForWorksheet: vi.fn(() => ""),
- getFoldersForWorksheet: vi.fn(() => []),
+ getPwdForSavedQuery: vi.fn(() => ""),
+ getFoldersForSavedQuery: vi.fn(() => []),
},
}));
@@ -45,8 +45,8 @@ vi.mock("@/stores/app", () => ({
vi.mock("@/modules/sql-editor/store", () => ({
useSQLEditorStore: (
- selector: (s: typeof mocks.editorWorksheetStore) => unknown
- ) => selector(mocks.editorWorksheetStore),
+ selector: (s: typeof mocks.editorSavedQueryStore) => unknown
+ ) => selector(mocks.editorSavedQueryStore),
}));
vi.mock("@/modules/sql-editor/model/Sheet", () => ({
@@ -58,10 +58,10 @@ vi.mock("@/types", () => ({
}));
vi.mock("@/utils", () => ({
- extractWorksheetID: vi.fn((worksheet: string) => {
- if (!worksheet) return "0";
- // Return non-zero for worksheets that look like real ones
- return worksheet.includes("/worksheets/") ? "123" : "0";
+ extractSavedQueryID: vi.fn((savedQuery: string) => {
+ if (!savedQuery) return "0";
+ // Return non-zero for saved queries that look like real ones
+ return savedQuery.includes("/savedQueries/") ? "123" : "0";
}),
}));
@@ -179,10 +179,10 @@ const emitSaveSheet = (payload: unknown) => {
};
// Tab fixtures
-const tabWithoutWorksheet = {
+const tabWithoutSavedQuery = {
id: "tab-1",
title: "Untitled",
- worksheet: undefined,
+ savedQuery: undefined,
connection: { database: "instances/inst1/databases/db1" },
statement: "SELECT 1",
};
@@ -190,7 +190,7 @@ const tabWithoutWorksheet = {
const savedTab = {
id: "tab-2",
title: "My Sheet",
- worksheet: "projects/proj1/worksheets/123",
+ savedQuery: "projects/proj1/savedQueries/123",
connection: { database: "instances/inst1/databases/db1" },
statement: "SELECT 2",
};
@@ -200,12 +200,12 @@ let SaveSheetModal: typeof import("./SaveSheetModal").SaveSheetModal;
beforeEach(async () => {
vi.clearAllMocks();
mocks.useTranslation.mockReturnValue({ t: (key: string) => key });
- mocks.editorWorksheetStore.abortAutoSave.mockReset();
- mocks.editorWorksheetStore.maybeUpdateWorksheet.mockResolvedValue(undefined);
- mocks.editorWorksheetStore.createWorksheet.mockResolvedValue(undefined);
- mocks.sheetContext.getPwdForWorksheet.mockReturnValue("");
- mocks.sheetContext.getFoldersForWorksheet.mockReturnValue([]);
- mocks.appStore.getWorksheetByName.mockReturnValue(undefined);
+ mocks.editorSavedQueryStore.abortAutoSave.mockReset();
+ mocks.editorSavedQueryStore.maybeUpdateSavedQuery.mockResolvedValue(undefined);
+ mocks.editorSavedQueryStore.createSavedQuery.mockResolvedValue(undefined);
+ mocks.sheetContext.getPwdForSavedQuery.mockReturnValue("");
+ mocks.sheetContext.getFoldersForSavedQuery.mockReturnValue([]);
+ mocks.appStore.getSavedQueryByName.mockReturnValue(undefined);
({ SaveSheetModal } = await import("./SaveSheetModal"));
});
@@ -223,7 +223,7 @@ describe("SaveSheetModal", () => {
);
render();
- emitSaveSheet({ tab: tabWithoutWorksheet });
+ emitSaveSheet({ tab: tabWithoutSavedQuery });
const dialog = container.querySelector("[data-testid='dialog']");
expect(dialog).not.toBeNull();
@@ -244,7 +244,7 @@ describe("SaveSheetModal", () => {
);
render();
- emitSaveSheet({ tab: tabWithoutWorksheet });
+ emitSaveSheet({ tab: tabWithoutSavedQuery });
const input = container.querySelector(
"[data-testid='title-input']"
@@ -255,7 +255,7 @@ describe("SaveSheetModal", () => {
unmount();
});
- test("2. Saved tab without editTitle saves silently — no modal, maybeUpdateWorksheet called", async () => {
+ test("2. Saved tab without editTitle saves silently — no modal, maybeUpdateSavedQuery called", async () => {
const { container, render, unmount } = renderIntoContainer(
<SaveSheetModal />
);
@@ -269,11 +269,11 @@ describe("SaveSheetModal", () => {
expect(dialog?.getAttribute("data-open")).toBe("false");
expect(
- mocks.editorWorksheetStore.maybeUpdateWorksheet
+ mocks.editorSavedQueryStore.maybeUpdateSavedQuery
).toHaveBeenCalledWith(
expect.objectContaining({
tabId: savedTab.id,
- worksheet: savedTab.worksheet,
+ savedQuery: savedTab.savedQuery,
title: savedTab.title,
database: savedTab.connection.database,
statement: savedTab.statement,
@@ -297,17 +297,17 @@ describe("SaveSheetModal", () => {
unmount();
});
- test("4. Save button stays enabled with an empty title (worksheet becomes Untitled)", async () => {
+ test("4. Save button stays enabled with an empty title (saved query becomes Untitled)", async () => {
const { container, render, unmount } = renderIntoContainer(
<SaveSheetModal />
);
render();
// Open modal with a tab that has an empty title — Save is allowed; the
- // worksheet is created with an empty title and the UI renders "Untitled"
+ // saved query is created with an empty title and the UI renders "Untitled"
// placeholders for it elsewhere.
const tabWithEmptyTitle = {
- ...tabWithoutWorksheet,
+ ...tabWithoutSavedQuery,
title: "",
};
emitSaveSheet({ tab: tabWithEmptyTitle });
@@ -322,7 +322,7 @@ describe("SaveSheetModal", () => {
saveButton.click();
});
- expect(mocks.editorWorksheetStore.createWorksheet).toHaveBeenCalledWith(
+ expect(mocks.editorSavedQueryStore.createSavedQuery).toHaveBeenCalledWith(
expect.objectContaining({
tabId: tabWithEmptyTitle.id,
title: "",
@@ -332,14 +332,14 @@ describe("SaveSheetModal", () => {
unmount();
});
- test("5. Clicking Save on unsaved tab calls createWorksheet with correct args", async () => {
+ test("5. Clicking Save on unsaved tab calls createSavedQuery with correct args", async () => {
const { container, render, unmount } = renderIntoContainer(
<SaveSheetModal />
);
render();
// Open modal for unsaved tab with a title set
- emitSaveSheet({ tab: tabWithoutWorksheet });
+ emitSaveSheet({ tab: tabWithoutSavedQuery });
const saveButton = Array.from(container.querySelectorAll("button")).find(
(b) => b.textContent === "common.save"
@@ -351,13 +351,13 @@ describe("SaveSheetModal", () => {
saveButton.click();
});
- expect(mocks.editorWorksheetStore.abortAutoSave).toHaveBeenCalled();
- expect(mocks.editorWorksheetStore.createWorksheet).toHaveBeenCalledWith(
+ expect(mocks.editorSavedQueryStore.abortAutoSave).toHaveBeenCalled();
+ expect(mocks.editorSavedQueryStore.createSavedQuery).toHaveBeenCalledWith(
expect.objectContaining({
- tabId: tabWithoutWorksheet.id,
- title: tabWithoutWorksheet.title,
- statement: tabWithoutWorksheet.statement,
- database: tabWithoutWorksheet.connection.database,
+ tabId: tabWithoutSavedQuery.id,
+ title: tabWithoutSavedQuery.title,
+ statement: tabWithoutSavedQuery.statement,
+ database: tabWithoutSavedQuery.connection.database,
})
);
@@ -370,7 +370,7 @@ describe("SaveSheetModal", () => {
);
render();
- // Worksheet exists (has a name) but its title is empty — a manual save
+ // SavedQuery exists (has a name) but its title is empty — a manual save
// should prompt for a title rather than silently re-persisting Untitled.
const savedUntitledTab = { ...savedTab, title: "" };
emitSaveSheet({ tab: savedUntitledTab });
@@ -378,7 +378,7 @@ describe("SaveSheetModal", () => {
const dialog = container.querySelector("[data-testid='dialog']");
expect(dialog?.getAttribute("data-open")).toBe("true");
expect(
- mocks.editorWorksheetStore.maybeUpdateWorksheet
+ mocks.editorSavedQueryStore.maybeUpdateSavedQuery
).not.toHaveBeenCalled();
unmount();
diff --git a/frontend/src/modules/sql-editor/components/SaveSheetModal.tsx b/frontend/src/modules/sql-editor/components/SaveSheetModal.tsx
index 2713c39e9f..7669061067 100644
--- a/frontend/src/modules/sql-editor/components/SaveSheetModal.tsx
+++ b/frontend/src/modules/sql-editor/components/SaveSheetModal.tsx
@@ -9,14 +9,16 @@ import { useSQLEditorStore } from "@/modules/sql-editor/store";
import { useAppStore } from "@/stores/app";
import type { SQLEditorTab } from "@/types";
import { UNKNOWN_ID } from "@/types";
-import { extractWorksheetID } from "@/utils";
+import { extractSavedQueryID } from "@/utils";
import { FolderForm } from "./FolderForm";
export function SaveSheetModal() {
const { t } = useTranslation();
const abortAutoSave = useSQLEditorStore((s) => s.abortAutoSave);
- const maybeUpdateWorksheet = useSQLEditorStore((s) => s.maybeUpdateWorksheet);
- const createWorksheet = useSQLEditorStore((s) => s.createWorksheet);
+ const maybeUpdateSavedQuery = useSQLEditorStore(
+ (s) => s.maybeUpdateSavedQuery
+ );
+ const createSavedQuery = useSQLEditorStore((s) => s.createSavedQuery);
const sheetContext = useSheetContextByView("my");
const [open, setOpen] = useState(false);
@@ -24,12 +26,12 @@ export function SaveSheetModal() {
const [folder, setFolder] = useState("");
const [rawTab, setRawTab] = useState<SQLEditorTab | undefined>(undefined);
- // A manual save opens the modal when the worksheet has never been saved
+ // A manual save opens the modal when the saved query has never been saved
// OR is still untitled, so the user can give it a title rather than
- // silently persisting an "Untitled" worksheet. Auto-save never reaches
- // here (it calls `maybeUpdateWorksheet` directly).
+ // silently persisting an "Untitled" savedQuery. Auto-save never reaches
+ // here (it calls `maybeUpdateSavedQuery` directly).
const needShowModal = (tab: SQLEditorTab) =>
- !tab.worksheet || !tab.title.trim();
+ !tab.savedQuery || !tab.title.trim();
const doSaveSheet = async (
tab?: SQLEditorTab,
@@ -49,21 +51,21 @@ export function SaveSheetModal() {
abortAutoSave();
- const { worksheet, connection, statement, id: tabId } = effectiveTab;
- const folders = sheetContext.getFoldersForWorksheet(effectiveFolder);
+ const { savedQuery, connection, statement, id: tabId } = effectiveTab;
+ const folders = sheetContext.getFoldersForSavedQuery(effectiveFolder);
- const sheetId = extractWorksheetID(worksheet ?? "");
+ const sheetId = extractSavedQueryID(savedQuery ?? "");
if (sheetId !== String(UNKNOWN_ID)) {
- await maybeUpdateWorksheet({
+ await maybeUpdateSavedQuery({
tabId,
- worksheet,
+ savedQuery,
title: effectiveTitle,
database: connection.database,
statement,
folders,
});
} else {
- await createWorksheet({
+ await createSavedQuery({
tabId,
title: effectiveTitle,
statement,
@@ -79,17 +81,17 @@ export function SaveSheetModal() {
setTitle(tab.title);
setRawTab(tab);
- // Compute the folder synchronously: for an already-saved worksheet, use
+ // Compute the folder synchronously: for an already-saved saved query, use
// its current pwd; otherwise reset. We then both reflect this in state
// (for the modal-open path) AND pass it explicitly into doSaveSheet
// (for the silent path) — bypassing React's async setState batching.
let nextFolder = "";
- if (tab.worksheet) {
- const worksheet = useAppStore
+ if (tab.savedQuery) {
+ const savedQuery = useAppStore
.getState()
- .getWorksheetByName(tab.worksheet);
- if (worksheet) {
- nextFolder = sheetContext.getPwdForWorksheet(worksheet);
+ .getSavedQueryByName(tab.savedQuery);
+ if (savedQuery) {
+ nextFolder = sheetContext.getPwdForSavedQuery(savedQuery);
}
}
setFolder(nextFolder);
diff --git a/frontend/src/modules/sql-editor/components/WorksheetPane.test.tsx b/frontend/src/modules/sql-editor/components/SavedQueryPane.test.tsx
similarity index 86%
rename from frontend/src/modules/sql-editor/components/WorksheetPane.test.tsx
rename to frontend/src/modules/sql-editor/components/SavedQueryPane.test.tsx
index 86c6f07363..f160ca4f28 100644
--- a/frontend/src/modules/sql-editor/components/WorksheetPane.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SavedQueryPane.test.tsx
@@ -2,7 +2,7 @@ import type { ReactElement } from "react";
import { act } from "react";
import { createRoot } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
-import type { WorksheetFolderNode } from "@/modules/sql-editor/model/Sheet";
+import type { SavedQueryFolderNode } from "@/modules/sql-editor/model/Sheet";
(
globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
@@ -228,14 +228,14 @@ vi.mock("./SheetTree", () => ({
}: {
view: string;
multiSelectMode?: boolean;
- checkedNodes?: WorksheetFolderNode[];
+ checkedNodes?: SavedQueryFolderNode[];
onMultiSelectModeChange: (m: boolean) => void;
- onCheckedNodesChange: (n: WorksheetFolderNode[]) => void;
+ onCheckedNodesChange: (n: SavedQueryFolderNode[]) => void;
ref?: React.Ref<{
- handleMultiDelete: (nodes: WorksheetFolderNode[]) => Promise<void>;
+ handleMultiDelete: (nodes: SavedQueryFolderNode[]) => Promise<void>;
}>;
}) => {
- // Expose the imperative handle on the ref so WorksheetPane can call it
+ // Expose the imperative handle on the ref so SavedQueryPane can call it
if (ref && typeof ref === "object") {
(ref as { current: unknown }).current = {
handleMultiDelete: vi.fn().mockResolvedValue(undefined),
@@ -264,13 +264,13 @@ vi.mock("./SheetTree", () => ({
editable: false,
children: [],
empty: true,
- worksheet: {
- name: "worksheets/ws1",
+ savedQuery: {
+ name: "savedQueries/ws1",
title: "ws1",
folders: [],
- type: "worksheet",
+ type: "savedQuery",
},
- } as WorksheetFolderNode,
+ } as SavedQueryFolderNode,
])
}
>
@@ -310,8 +310,8 @@ const setupDefaultMocks = (overrides: Partial<Filter> = {}) => {
const filterRef = { value: filter };
const filterChanged = false;
- const batchUpdateWorksheetFolders = vi.fn().mockResolvedValue(undefined);
- const getFoldersForWorksheet = vi.fn((path: string): string[] =>
+ const batchUpdateSavedQueryFolders = vi.fn().mockResolvedValue(undefined);
+ const getFoldersForSavedQuery = vi.fn((path: string): string[] =>
!path || path === "/my" ? [] : [path]
);
const sheetTree = {
@@ -325,22 +325,22 @@ const setupDefaultMocks = (overrides: Partial<Filter> = {}) => {
editable: false,
children: [],
empty: true,
- worksheet: {
- name: "worksheets/ws1",
+ savedQuery: {
+ name: "savedQueries/ws1",
title: "ws1",
folders: [],
- type: "worksheet",
+ type: "savedQuery",
},
- } as WorksheetFolderNode,
+ } as SavedQueryFolderNode,
],
- } as WorksheetFolderNode;
+ } as SavedQueryFolderNode;
mocks.useSheetContext.mockReturnValue({
get filter() {
return filterRef.value;
},
filterChanged,
- batchUpdateWorksheetFolders,
+ batchUpdateSavedQueryFolders,
setFilter: vi.fn((next: Filter | ((prev: Filter) => Filter)) => {
filterRef.value =
typeof next === "function" ? next(filterRef.value) : next;
@@ -348,11 +348,11 @@ const setupDefaultMocks = (overrides: Partial<Filter> = {}) => {
});
mocks.useSheetContextByView.mockReturnValue({
- getFoldersForWorksheet,
+ getFoldersForSavedQuery,
sheetTree,
});
- return { filterRef, batchUpdateWorksheetFolders, getFoldersForWorksheet };
+ return { filterRef, batchUpdateSavedQueryFolders, getFoldersForSavedQuery };
};
const renderIntoContainer = (element: ReactElement) => {
@@ -380,11 +380,11 @@ const renderIntoContainer = (element: ReactElement) => {
};
};
-let WorksheetPane: typeof import("./WorksheetPane").WorksheetPane;
+let SavedQueryPane: typeof import("./SavedQueryPane").SavedQueryPane;
beforeEach(async () => {
vi.clearAllMocks();
- ({ WorksheetPane } = await import("./WorksheetPane"));
+ ({ SavedQueryPane } = await import("./SavedQueryPane"));
});
afterEach(() => {
@@ -394,11 +394,11 @@ afterEach(() => {
// ---- tests ------------------------------------------------------------------
-describe("WorksheetPane", () => {
+describe("SavedQueryPane", () => {
test("1. Renders SheetTree for each enabled view", () => {
setupDefaultMocks();
const { container, render, unmount } = renderIntoContainer(
- <WorksheetPane />
+ <SavedQueryPane />
);
render();
@@ -412,7 +412,7 @@ describe("WorksheetPane", () => {
test("2. Hides 'my' SheetTree when showMine is false", () => {
setupDefaultMocks({ showMine: false });
const { container, render, unmount } = renderIntoContainer(
- <WorksheetPane />
+ <SavedQueryPane />
);
render();
@@ -426,7 +426,7 @@ describe("WorksheetPane", () => {
test("3. Filter menu item toggle writes back to filter ref", () => {
const { filterRef } = setupDefaultMocks();
const { container, render, unmount } = renderIntoContainer(
- <WorksheetPane />
+ <SavedQueryPane />
);
render();
@@ -451,7 +451,7 @@ describe("WorksheetPane", () => {
test("4. Multi-select toolbar appears when a SheetTree enters multi-select", () => {
setupDefaultMocks();
const { container, render, unmount } = renderIntoContainer(
- <WorksheetPane />
+ <SavedQueryPane />
);
render();
@@ -473,12 +473,12 @@ describe("WorksheetPane", () => {
expect(myTree?.getAttribute("data-multi-select-mode")).toBe("true");
// Toolbar buttons rendered — Move + Cancel stay inline; destructive
- // Delete is tucked into the More menu for the narrow worksheet pane.
+ // Delete is tucked into the More menu for the narrow saved query pane.
const toolbarButtons = Array.from(
container.querySelectorAll("[data-testid='button']")
).map((el) => el.textContent?.trim());
expect(toolbarButtons).toEqual(
- expect.arrayContaining(["sheet.move-worksheets", "common.cancel"])
+ expect.arrayContaining(["sheet.move-saved-queries", "common.cancel"])
);
expect(toolbarButtons).not.toContain("common.delete");
const menuItems = Array.from(
@@ -490,15 +490,15 @@ describe("WorksheetPane", () => {
unmount();
});
- test("5. Move modal opens and submit calls batchUpdateWorksheetFolders", async () => {
- const { batchUpdateWorksheetFolders, getFoldersForWorksheet } =
+ test("5. Move modal opens and submit calls batchUpdateSavedQueryFolders", async () => {
+ const { batchUpdateSavedQueryFolders, getFoldersForSavedQuery } =
setupDefaultMocks();
const { container, render, unmount } = renderIntoContainer(
- <WorksheetPane />
+ <SavedQueryPane />
);
render();
- // Step 1: enter multi-select and check a worksheet
+ // Step 1: enter multi-select and check a saved query
act(() => {
container
.querySelector("[data-testid='sheet-tree-my-enter-multi-select']")
@@ -510,10 +510,10 @@ describe("WorksheetPane", () => {
?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
});
- // Step 2: click the "move-worksheets" toolbar button to open the modal
+ // Step 2: click the "move-saved-queries" toolbar button to open the modal
const moveButton = Array.from(
container.querySelectorAll("[data-testid='button']")
- ).find((el) => el.textContent?.trim() === "sheet.move-worksheets") as
+ ).find((el) => el.textContent?.trim() === "sheet.move-saved-queries") as
| HTMLButtonElement
| undefined;
expect(moveButton).not.toBeUndefined();
@@ -542,19 +542,19 @@ describe("WorksheetPane", () => {
saveButton?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
});
- expect(getFoldersForWorksheet).toHaveBeenCalledWith("/some/folder");
- expect(batchUpdateWorksheetFolders).toHaveBeenCalledWith([
- { name: "worksheets/ws1", folders: ["/some/folder"] },
+ expect(getFoldersForSavedQuery).toHaveBeenCalledWith("/some/folder");
+ expect(batchUpdateSavedQueryFolders).toHaveBeenCalledWith([
+ { name: "savedQueries/ws1", folders: ["/some/folder"] },
]);
unmount();
});
- test("5b. Move modal can move worksheets to the root folder", async () => {
- const { batchUpdateWorksheetFolders, getFoldersForWorksheet } =
+ test("5b. Move modal can move saved queries to the root folder", async () => {
+ const { batchUpdateSavedQueryFolders, getFoldersForSavedQuery } =
setupDefaultMocks();
const { container, render, unmount } = renderIntoContainer(
- <WorksheetPane />
+ <SavedQueryPane />
);
render();
@@ -571,7 +571,7 @@ describe("WorksheetPane", () => {
const moveButton = Array.from(
container.querySelectorAll("[data-testid='button']")
- ).find((el) => el.textContent?.trim() === "sheet.move-worksheets");
+ ).find((el) => el.textContent?.trim() === "sheet.move-saved-queries");
act(() => {
moveButton?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
});
@@ -599,9 +599,9 @@ describe("WorksheetPane", () => {
saveButton?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
});
- expect(getFoldersForWorksheet).toHaveBeenCalledWith("/my");
- expect(batchUpdateWorksheetFolders).toHaveBeenCalledWith([
- { name: "worksheets/ws1", folders: [] },
+ expect(getFoldersForSavedQuery).toHaveBeenCalledWith("/my");
+ expect(batchUpdateSavedQueryFolders).toHaveBeenCalledWith([
+ { name: "savedQueries/ws1", folders: [] },
]);
unmount();
diff --git a/frontend/src/modules/sql-editor/components/WorksheetPane.tsx b/frontend/src/modules/sql-editor/components/SavedQueryPane.tsx
similarity index 87%
rename from frontend/src/modules/sql-editor/components/WorksheetPane.tsx
rename to frontend/src/modules/sql-editor/components/SavedQueryPane.tsx
index 8e61f2d109..f800e9bc15 100644
--- a/frontend/src/modules/sql-editor/components/WorksheetPane.tsx
+++ b/frontend/src/modules/sql-editor/components/SavedQueryPane.tsx
@@ -1,7 +1,7 @@
/**
- * WorksheetPane — React port of WorksheetPane.vue (Stage 12, Phase 4).
+ * SavedQueryPane — React port of SavedQueryPane.vue (Stage 12, Phase 4).
*
- * Hosts the SQL editor's worksheet sidebar: search, filter menu, multi-select
+ * Hosts the SQL editor's saved query sidebar: search, filter menu, multi-select
* toolbar, move-to-folder dialog, and one SheetTree per visible view.
*/
@@ -22,8 +22,8 @@ import {
import { SearchInput } from "@/components/ui/search-input";
import { cn } from "@/lib/utils";
import type {
+ SavedQueryFolderNode,
SheetViewMode,
- WorksheetFolderNode,
} from "@/modules/sql-editor/model/Sheet";
import {
useSheetContext,
@@ -34,8 +34,8 @@ import { FolderForm } from "./FolderForm";
import { SheetTree, type SheetTreeHandle } from "./SheetTree";
function collectSelectableNodes(
- node: WorksheetFolderNode | undefined
-): WorksheetFolderNode[] {
+ node: SavedQueryFolderNode | undefined
+): SavedQueryFolderNode[] {
if (!node || node.loadMore) return [];
return [
node,
@@ -43,20 +43,20 @@ function collectSelectableNodes(
];
}
-export function WorksheetPane() {
+export function SavedQueryPane() {
const { t } = useTranslation();
const sheetContext = useSheetContext();
- const { filter, filterChanged, batchUpdateWorksheetFolders, setFilter } =
+ const { filter, filterChanged, batchUpdateSavedQueryFolders, setFilter } =
sheetContext;
const myViewContext = useSheetContextByView("my");
- const { getFoldersForWorksheet } = myViewContext;
+ const { getFoldersForSavedQuery } = myViewContext;
const mineSheetTreeRef = useRef<SheetTreeHandle>(null);
const [multiSelectMode, setMultiSelectMode] = useState(false);
- const [checkedNodes, setCheckedNodes] = useState<WorksheetFolderNode[]>([]);
+ const [checkedNodes, setCheckedNodes] = useState<SavedQueryFolderNode[]>([]);
const [showReorgModal, setShowReorgModal] = useState(false);
const [pendingMoveFolder, setPendingMoveFolder] = useState("");
const [loading, setLoading] = useState(false);
@@ -76,11 +76,11 @@ export function WorksheetPane() {
return results;
}, [filter.showShared, filter.showDraft]);
- const checkedWorksheets = useMemo(
+ const checkedSavedQueries = useMemo(
() =>
checkedNodes
- .filter((node) => node.worksheet)
- .map((node) => node.worksheet!.name),
+ .filter((node) => node.savedQuery)
+ .map((node) => node.savedQuery!.name),
[checkedNodes]
);
const selectableNodes = useMemo(
@@ -112,12 +112,12 @@ export function WorksheetPane() {
}
};
- const handleMoveWorksheets = async () => {
+ const handleMoveSavedQueries = async () => {
setLoading(true);
try {
- const folders = getFoldersForWorksheet(pendingMoveFolder);
- await batchUpdateWorksheetFolders(
- checkedWorksheets.map((worksheet) => ({ name: worksheet, folders }))
+ const folders = getFoldersForSavedQuery(pendingMoveFolder);
+ await batchUpdateSavedQueryFolders(
+ checkedSavedQueries.map((savedQuery) => ({ name: savedQuery, folders }))
);
setShowReorgModal(false);
setMultiSelectMode(false);
@@ -135,13 +135,13 @@ export function WorksheetPane() {
const batchActions: SelectionAction[] = [
{
key: "move",
- label: t("sheet.move-worksheets"),
+ label: t("sheet.move-saved-queries"),
icon: FolderInputIcon,
onClick: () => {
setPendingMoveFolder("");
setShowReorgModal(true);
},
- disabled: checkedWorksheets.length === 0 || loading,
+ disabled: checkedSavedQueries.length === 0 || loading,
},
{
key: "cancel",
@@ -209,7 +209,7 @@ export function WorksheetPane() {
<div
className={cn(
- "relative flex min-w-0 max-w-full flex-1 flex-col gap-y-2 overflow-y-auto overflow-x-hidden worksheet-scroll",
+ "relative flex min-w-0 max-w-full flex-1 flex-col gap-y-2 overflow-y-auto overflow-x-hidden",
showMultiSelectToolbar && "pb-16"
)}
>
@@ -260,7 +260,7 @@ export function WorksheetPane() {
onOpenChange={(open) => !open && closeReorgModal()}
>
<DialogContent className="w-lg max-w-[calc(100vw-8rem)] p-6">
- <DialogTitle>{t("sheet.move-worksheets")}</DialogTitle>
+ <DialogTitle>{t("sheet.move-saved-queries")}</DialogTitle>
<div className="mt-3 flex flex-col gap-y-3">
<FolderForm
folder={pendingMoveFolder}
@@ -271,7 +271,7 @@ export function WorksheetPane() {
<Button appearance="outline" onClick={closeReorgModal}>
{t("common.close")}
</Button>
- <Button onClick={handleMoveWorksheets} disabled={loading}>
+ <Button onClick={handleMoveSavedQueries} disabled={loading}>
{t("common.save")}
</Button>
</div>
diff --git a/frontend/src/modules/sql-editor/components/SchemaPane/SchemaPane.test.tsx b/frontend/src/modules/sql-editor/components/SchemaPane/SchemaPane.test.tsx
index 1641ea0b6f..df0fe15d07 100644
--- a/frontend/src/modules/sql-editor/components/SchemaPane/SchemaPane.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SchemaPane/SchemaPane.test.tsx
@@ -99,7 +99,7 @@ vi.mock("@/modules/sql-editor/store/tab", () => ({
vi.mock("@/types", () => ({
isValidDatabaseName: mocks.isValidDatabaseName,
- DEFAULT_SQL_EDITOR_TAB_MODE: "WORKSHEET",
+ DEFAULT_SQL_EDITOR_TAB_MODE: "SAVED_QUERY",
dialectOfEngineV1: () => "MYSQL",
languageOfEngineV1: () => "sql",
typeToView: (type: string) => type.toUpperCase(),
@@ -126,7 +126,7 @@ vi.mock("@/utils", () => ({
viewState: { view: "CODE" },
treeState: { database: "", keys: [] },
editorState: { selection: null },
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
status: "NEW",
}),
extractDatabaseResourceName: (n: string) => ({
diff --git a/frontend/src/modules/sql-editor/components/SchemaPane/actions.test.tsx b/frontend/src/modules/sql-editor/components/SchemaPane/actions.test.tsx
index 41e21e98a0..dae2e99944 100644
--- a/frontend/src/modules/sql-editor/components/SchemaPane/actions.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SchemaPane/actions.test.tsx
@@ -103,7 +103,7 @@ vi.mock("@/utils", () => ({
viewState: { view: "CODE" },
treeState: {},
editorState: { selection: null },
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
status: "NEW",
}),
extractDatabaseResourceName: (n: string) => ({
@@ -125,7 +125,7 @@ vi.mock("@/utils", () => ({
}));
vi.mock("@/types", () => ({
- DEFAULT_SQL_EDITOR_TAB_MODE: "WORKSHEET",
+ DEFAULT_SQL_EDITOR_TAB_MODE: "SAVED_QUERY",
dialectOfEngineV1: () => "MYSQL",
languageOfEngineV1: () => "sql",
typeToView: (type: string) => type.toUpperCase(),
diff --git a/frontend/src/modules/sql-editor/components/SharePopoverBody.test.tsx b/frontend/src/modules/sql-editor/components/SharePopoverBody.test.tsx
index cc52045d1b..ec9dbac48e 100644
--- a/frontend/src/modules/sql-editor/components/SharePopoverBody.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SharePopoverBody.test.tsx
@@ -13,12 +13,12 @@ const mocks = vi.hoisted(() => ({
| { externalUrl: string }
| undefined,
useCurrentUser: vi.fn(),
- patchWorksheet: vi.fn().mockResolvedValue({}),
+ patchSavedQuery: vi.fn().mockResolvedValue({}),
pushNotification: vi.fn(),
extractProjectResourceName: vi.fn(
(name: string) => name.split("/")[1] ?? name
),
- extractWorksheetID: vi.fn((name: string) => name.split("/")[3] ?? name),
+ extractSavedQueryID: vi.fn((name: string) => name.split("/")[3] ?? name),
routerResolve: vi.fn(() => ({ href: "/sql-editor/projects/proj1/sheets/1" })),
}));
@@ -36,7 +36,7 @@ vi.mock("@/stores/app", () => {
// from the Pinia helper to the app-store notification slice.
const state = () => ({
serverInfo: mocks.serverInfo,
- patchWorksheet: mocks.patchWorksheet,
+ patchSavedQuery: mocks.patchSavedQuery,
notify: mocks.pushNotification,
});
return {
@@ -49,7 +49,7 @@ vi.mock("@/stores/app", () => {
vi.mock("@/utils", () => ({
extractProjectResourceName: mocks.extractProjectResourceName,
- extractWorksheetID: mocks.extractWorksheetID,
+ extractSavedQueryID: mocks.extractSavedQueryID,
}));
vi.mock("@/app/router", async (importOriginal) => ({
@@ -86,8 +86,8 @@ vi.mock("@/components/ui/tooltip", () => ({
let SharePopoverBody: typeof import("./SharePopoverBody").SharePopoverBody;
-const mockWorksheet = {
- name: "projects/proj1/worksheets/1",
+const mockSavedQuery = {
+ name: "projects/proj1/savedQueries/1",
project: "projects/proj1",
creator: "users/[email protected]",
visibility: 3 /* PRIVATE */,
@@ -124,7 +124,7 @@ beforeEach(async () => {
name: "users/[email protected]",
});
- mocks.patchWorksheet.mockResolvedValue({});
+ mocks.patchSavedQuery.mockResolvedValue({});
// Mock clipboard
Object.defineProperty(navigator, "clipboard", {
@@ -143,7 +143,7 @@ afterEach(() => {
describe("SharePopoverBody", () => {
test("renders Share title and link input", () => {
const { container, render, unmount } = renderIntoContainer(
- <SharePopoverBody worksheet={mockWorksheet as never} />
+ <SharePopoverBody savedQuery={mockSavedQuery as never} />
);
render();
expect(container.textContent).toContain("common.share");
@@ -154,7 +154,7 @@ describe("SharePopoverBody", () => {
test("shows 3 visibility options when selector is opened", () => {
const { container, render, unmount } = renderIntoContainer(
- <SharePopoverBody worksheet={mockWorksheet as never} />
+ <SharePopoverBody savedQuery={mockSavedQuery as never} />
);
render();
// The popover-content should contain 3 options
@@ -176,7 +176,7 @@ describe("SharePopoverBody", () => {
});
const { container, render, unmount } = renderIntoContainer(
- <SharePopoverBody worksheet={mockWorksheet as never} />
+ <SharePopoverBody savedQuery={mockSavedQuery as never} />
);
render();
// Trigger should have disabled styling
@@ -185,11 +185,11 @@ describe("SharePopoverBody", () => {
unmount();
});
- test("handleChangeAccess calls patchWorksheet and pushNotification but does NOT close the outer popover", async () => {
- const patchWorksheet = mocks.patchWorksheet;
+ test("handleChangeAccess calls patchSavedQuery and pushNotification but does NOT close the outer popover", async () => {
+ const patchSavedQuery = mocks.patchSavedQuery;
const { container, render, unmount } = renderIntoContainer(
- <SharePopoverBody worksheet={mockWorksheet as never} />
+ <SharePopoverBody savedQuery={mockSavedQuery as never} />
);
render();
@@ -204,7 +204,7 @@ describe("SharePopoverBody", () => {
(optionRows?.[1] as HTMLElement)?.click();
});
- expect(patchWorksheet).toHaveBeenCalledTimes(1);
+ expect(patchSavedQuery).toHaveBeenCalledTimes(1);
expect(mocks.pushNotification).toHaveBeenCalledTimes(1);
// The SharePopoverBody no longer signals "close me" on access
// change — the outer share popover stays open so the user can copy
@@ -215,8 +215,8 @@ describe("SharePopoverBody", () => {
test("copy button writes to clipboard and pushes notification", async () => {
const { container, render, unmount } = renderIntoContainer(
<SharePopoverBody
- worksheet={
- { ...mockWorksheet, visibility: 1 /* PROJECT_READ */ } as never
+ savedQuery={
+ { ...mockSavedQuery, visibility: 1 /* PROJECT_READ */ } as never
}
/>
);
@@ -236,12 +236,12 @@ describe("SharePopoverBody", () => {
unmount();
});
- test("copy button disabled when there is no shareable worksheet link", () => {
- // No worksheet (an unsaved draft) → no link → copy disabled. A saved
- // worksheet from the tree always has a link, so copy is enabled regardless
- // of the current tab's status (covered by the private-worksheet test below).
+ test("copy button disabled when there is no shareable saved query link", () => {
+ // No saved query (an unsaved draft) → no link → copy disabled. A saved
+ // saved query from the tree always has a link, so copy is enabled regardless
+ // of the current tab's status (covered by the private-saved-query test below).
const { container, render, unmount } = renderIntoContainer(
- <SharePopoverBody worksheet={undefined as never} />
+ <SharePopoverBody savedQuery={undefined as never} />
);
render();
@@ -253,11 +253,11 @@ describe("SharePopoverBody", () => {
unmount();
});
- test("copy button enabled for a private worksheet (share status ignored)", () => {
- // mockWorksheet is PRIVATE; the copy button stays enabled regardless of
+ test("copy button enabled for a private saved query (share status ignored)", () => {
+ // mockSavedQuery is PRIVATE; the copy button stays enabled regardless of
// share status, gated only by the tab's saved state.
const { container, render, unmount } = renderIntoContainer(
- <SharePopoverBody worksheet={mockWorksheet as never} />
+ <SharePopoverBody savedQuery={mockSavedQuery as never} />
);
render();
diff --git a/frontend/src/modules/sql-editor/components/SharePopoverBody.tsx b/frontend/src/modules/sql-editor/components/SharePopoverBody.tsx
index e403bfcb72..8dc7737cfd 100644
--- a/frontend/src/modules/sql-editor/components/SharePopoverBody.tsx
+++ b/frontend/src/modules/sql-editor/components/SharePopoverBody.tsx
@@ -9,7 +9,7 @@ import {
import { useEffect, useMemo, useState } from "react";
import { useTranslation } from "react-i18next";
import { router } from "@/app/router";
-import { SQL_EDITOR_WORKSHEET_MODULE } from "@/app/router/handles";
+import { SQL_EDITOR_SAVED_QUERY_MODULE } from "@/app/router/handles";
import { Button } from "@/components/ui/button";
import {
Popover,
@@ -20,26 +20,26 @@ import { useCurrentUser } from "@/hooks/useAppState";
import { writeTextToClipboard } from "@/lib/clipboard";
import { cn } from "@/lib/utils";
import { useAppStore } from "@/stores/app";
-import type { Worksheet } from "@/types/proto-es/v1/worksheet_service_pb";
-import { Worksheet_Visibility } from "@/types/proto-es/v1/worksheet_service_pb";
-import { extractProjectResourceName, extractWorksheetID } from "@/utils";
+import type { SavedQuery } from "@/types/proto-es/v1/saved_query_service_pb";
+import { SavedQuery_Visibility } from "@/types/proto-es/v1/saved_query_service_pb";
+import { extractProjectResourceName, extractSavedQueryID } from "@/utils";
type AccessOption = {
label: string;
description: string;
- value: Worksheet_Visibility;
+ value: SavedQuery_Visibility;
icon: React.ReactNode;
};
type Props = {
- readonly worksheet?: Worksheet;
+ readonly savedQuery?: SavedQuery;
};
/**
* Replaces frontend/src/views/sql-editor/EditorCommon/SharePopover.vue.
* Renders the share popover body content: visibility selector + shareable link.
*/
-export function SharePopoverBody({ worksheet }: Props) {
+export function SharePopoverBody({ savedQuery }: Props) {
const { t } = useTranslation();
const workspaceExternalURL = useAppStore((s) => s.serverInfo?.externalUrl);
const currentUser = useCurrentUser();
@@ -49,19 +49,19 @@ export function SharePopoverBody({ worksheet }: Props) {
{
label: t("sql-editor.private"),
description: t("sql-editor.private-desc"),
- value: Worksheet_Visibility.PRIVATE,
+ value: SavedQuery_Visibility.PRIVATE,
icon: <LockKeyhole className="size-5" />,
},
{
label: t("sql-editor.project-read"),
description: t("sql-editor.project-read-desc"),
- value: Worksheet_Visibility.PROJECT_READ,
+ value: SavedQuery_Visibility.PROJECT_READ,
icon: <Users className="size-5" />,
},
{
label: t("sql-editor.project-write"),
description: t("sql-editor.project-write-desc"),
- value: Worksheet_Visibility.PROJECT_WRITE,
+ value: SavedQuery_Visibility.PROJECT_WRITE,
icon: <Users className="size-5" />,
},
],
@@ -69,9 +69,9 @@ export function SharePopoverBody({ worksheet }: Props) {
);
const allowChangeAccess = useMemo(() => {
- if (!worksheet || !currentUser) return false;
- return worksheet.creator === `users/${currentUser.email}`;
- }, [worksheet, currentUser]);
+ if (!savedQuery || !currentUser) return false;
+ return savedQuery.creator === `users/${currentUser.email}`;
+ }, [savedQuery, currentUser]);
const [currentAccess, setCurrentAccess] = useState<AccessOption>(
() => accessOptions[0]
@@ -79,37 +79,37 @@ export function SharePopoverBody({ worksheet }: Props) {
const [selectorOpen, setSelectorOpen] = useState(false);
- // Sync currentAccess from worksheet.visibility when worksheet changes
+ // Sync currentAccess from savedQuery.visibility when saved query changes
useEffect(() => {
- if (!worksheet) return;
+ if (!savedQuery) return;
const idx = accessOptions.findIndex(
- (opt) => opt.value === worksheet.visibility
+ (opt) => opt.value === savedQuery.visibility
);
setCurrentAccess(idx !== -1 ? accessOptions[idx] : accessOptions[0]);
- }, [worksheet, accessOptions]);
+ }, [savedQuery, accessOptions]);
const sharedTabLink = useMemo(() => {
- if (!worksheet) return "";
+ if (!savedQuery) return "";
const route = router.resolve({
- name: SQL_EDITOR_WORKSHEET_MODULE,
+ name: SQL_EDITOR_SAVED_QUERY_MODULE,
params: {
- project: extractProjectResourceName(worksheet.project),
- sheet: extractWorksheetID(worksheet.name),
+ project: extractProjectResourceName(savedQuery.project),
+ savedQuery: extractSavedQueryID(savedQuery.name),
},
});
return new URL(route.href, workspaceExternalURL || window.location.origin)
.href;
- }, [worksheet, workspaceExternalURL]);
+ }, [savedQuery, workspaceExternalURL]);
const handleChangeAccess = async (option: AccessOption) => {
- if (!allowChangeAccess || !worksheet) {
+ if (!allowChangeAccess || !savedQuery) {
setSelectorOpen(false);
return;
}
setCurrentAccess(option);
await useAppStore
.getState()
- .patchWorksheet({ ...worksheet, visibility: option.value }, [
+ .patchSavedQuery({ ...savedQuery, visibility: option.value }, [
"visibility",
]);
@@ -230,11 +230,11 @@ export function SharePopoverBody({ worksheet }: Props) {
value={sharedTabLink}
className="flex-1 min-w-0 h-full px-2 bg-background text-control text-sm cursor-text appearance-none border-0 shadow-none outline-hidden focus:outline-hidden focus:ring-0 focus:border-0 focus:shadow-none"
/>
- {/* Copy button — enabled whenever the shared worksheet has a link.
- Gated on the shared worksheet (sharedTabLink), NOT the current tab's
- status: the popover can be opened for any worksheet from the tree,
+ {/* Copy button — enabled whenever the shared savedQuery has a link.
+ Gated on the shared savedQuery (sharedTabLink), NOT the current tab's
+ status: the popover can be opened for any savedQuery from the tree,
so the current tab's dirty state is irrelevant. Only an unsaved draft
- (no worksheet → no link) disables it. */}
+ (no savedQuery → no link) disables it. */}
<Button
type="button"
appearance="secondary"
diff --git a/frontend/src/modules/sql-editor/components/SheetTree.test.tsx b/frontend/src/modules/sql-editor/components/SheetTree.test.tsx
index 0dd880e1bc..334f3c8ccd 100644
--- a/frontend/src/modules/sql-editor/components/SheetTree.test.tsx
+++ b/frontend/src/modules/sql-editor/components/SheetTree.test.tsx
@@ -2,7 +2,7 @@ import type { ReactElement } from "react";
import { act, forwardRef } from "react";
import { createRoot } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
-import type { WorksheetFolderNode } from "@/modules/sql-editor/model/Sheet";
+import type { SavedQueryFolderNode } from "@/modules/sql-editor/model/Sheet";
(
globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
@@ -20,24 +20,24 @@ globalThis.ResizeObserver = class ResizeObserver {
const mocks = vi.hoisted(() => ({
useTranslation: vi.fn(() => ({ t: (key: string) => key })),
appStore: {
- getWorksheetByName: vi.fn(),
- deleteWorksheetByName: vi.fn(),
- patchWorksheet: vi.fn(),
- upsertWorksheetOrganizer: vi.fn(),
+ getSavedQueryByName: vi.fn(),
+ deleteSavedQueryByName: vi.fn(),
+ patchSavedQuery: vi.fn(),
+ upsertSavedQueryOrganizer: vi.fn(),
} as {
- getWorksheetByName: ReturnType<typeof vi.fn>;
- deleteWorksheetByName: ReturnType<typeof vi.fn>;
- patchWorksheet: ReturnType<typeof vi.fn>;
- upsertWorksheetOrganizer: ReturnType<typeof vi.fn>;
+ getSavedQueryByName: ReturnType<typeof vi.fn>;
+ deleteSavedQueryByName: ReturnType<typeof vi.fn>;
+ patchSavedQuery: ReturnType<typeof vi.fn>;
+ upsertSavedQueryOrganizer: ReturnType<typeof vi.fn>;
},
getSQLEditorTabsState: vi.fn(),
project: "projects/proj1",
- // The new zustand store mock — only `createWorksheet` is used by SheetTree.
- createWorksheet: vi.fn().mockResolvedValue({}),
+ // The new zustand store mock — only `createSavedQuery` is used by SheetTree.
+ createSavedQuery: vi.fn().mockResolvedValue({}),
useSheetContext: vi.fn(),
useSheetContextByView: vi.fn(),
useDropdown: vi.fn(),
- openWorksheetByName: vi.fn(),
+ openSavedQueryByName: vi.fn(),
pushNotification: vi.fn(),
treeProps: {} as {
disableDrag?: unknown;
@@ -70,20 +70,20 @@ vi.mock("@/modules/sql-editor/store/editor", () => ({
vi.mock("@/modules/sql-editor/store", () => ({
useSQLEditorStore: (
- selector: (s: { createWorksheet: typeof mocks.createWorksheet }) => unknown
- ) => selector({ createWorksheet: mocks.createWorksheet }),
+ selector: (s: { createSavedQuery: typeof mocks.createSavedQuery }) => unknown
+ ) => selector({ createSavedQuery: mocks.createSavedQuery }),
}));
vi.mock("@/modules/sql-editor/model/Sheet", () => ({
useSheetContext: mocks.useSheetContext,
useSheetContextByView: mocks.useSheetContextByView,
- openWorksheetByName: mocks.openWorksheetByName,
+ openSavedQueryByName: mocks.openSavedQueryByName,
revealNodes: (
- node: WorksheetFolderNode,
- cb: (n: WorksheetFolderNode) => unknown
+ node: SavedQueryFolderNode,
+ cb: (n: SavedQueryFolderNode) => unknown
) => {
const results: unknown[] = [];
- const walk = (n: WorksheetFolderNode) => {
+ const walk = (n: SavedQueryFolderNode) => {
const r = cb(n);
if (r !== undefined) results.push(r);
for (const c of n.children) walk(c);
@@ -91,13 +91,13 @@ vi.mock("@/modules/sql-editor/model/Sheet", () => ({
walk(node);
return results;
},
- revealWorksheets: (
- node: WorksheetFolderNode,
- cb: (n: WorksheetFolderNode) => unknown
+ revealSavedQueries: (
+ node: SavedQueryFolderNode,
+ cb: (n: SavedQueryFolderNode) => unknown
) => {
const results: unknown[] = [];
- const walk = (n: WorksheetFolderNode) => {
- if (n.worksheet) {
+ const walk = (n: SavedQueryFolderNode) => {
+ if (n.savedQuery) {
const r = cb(n);
if (r !== undefined) results.push(r);
}
@@ -119,7 +119,7 @@ vi.mock("./filterNode", () => ({
// Mock Tree primitive — renders all nodes (recursively) via renderNode
type MockTreeItem = {
id: string;
- data: WorksheetFolderNode;
+ data: SavedQueryFolderNode;
children?: MockTreeItem[];
};
type MockRenderArgs = {
@@ -331,20 +331,20 @@ vi.mock("./TreeNodeSuffix", () => ({
onToggleStar,
node,
}: {
- node: WorksheetFolderNode;
+ node: SavedQueryFolderNode;
view: string;
- onToggleStar?: (args: { worksheet: string; starred: boolean }) => void;
- onSharePanelShow?: (e: React.MouseEvent, node: WorksheetFolderNode) => void;
+ onToggleStar?: (args: { savedQuery: string; starred: boolean }) => void;
+ onSharePanelShow?: (e: React.MouseEvent, node: SavedQueryFolderNode) => void;
onContextMenuShow?: (
e: React.MouseEvent,
- node: WorksheetFolderNode
+ node: SavedQueryFolderNode
) => void;
}) => (
<div
data-testid="tree-node-suffix"
onClick={() => {
- if (node.worksheet) {
- onToggleStar?.({ worksheet: node.worksheet.name, starred: true });
+ if (node.savedQuery) {
+ onToggleStar?.({ savedQuery: node.savedQuery.name, starred: true });
}
}}
/>
@@ -355,9 +355,9 @@ vi.mock("./TreeNodeSuffix", () => ({
const makeFolderNode = (
key: string,
- children: WorksheetFolderNode[] = [],
+ children: SavedQueryFolderNode[] = [],
editable = false
-): WorksheetFolderNode => ({
+): SavedQueryFolderNode => ({
key,
label: key.split("/").slice(-1)[0],
editable,
@@ -365,24 +365,24 @@ const makeFolderNode = (
empty: children.length === 0,
});
-const makeWorksheetNode = (
+const makeSavedQueryNode = (
key: string,
- name = "worksheets/ws1"
-): WorksheetFolderNode => ({
+ name = "savedQueries/ws1"
+): SavedQueryFolderNode => ({
key,
label: key.split("/").slice(-1)[0],
editable: false,
children: [],
empty: true,
- worksheet: {
+ savedQuery: {
name,
title: "My Query",
folders: [],
- type: "worksheet",
+ type: "savedQuery",
},
});
-const makeLoadMoreNode = (key: string): WorksheetFolderNode => ({
+const makeLoadMoreNode = (key: string): SavedQueryFolderNode => ({
key,
label: "common.load-more",
editable: false,
@@ -408,8 +408,8 @@ const setupDefaultMocks = () => {
mocks.useTranslation.mockReturnValue({ t: (key: string) => key });
const rootNode = makeFolderNode("/my", [
- makeFolderNode("/my/folder1", [makeWorksheetNode("/my/folder1/ws1")]),
- makeWorksheetNode("/my/ws2"),
+ makeFolderNode("/my/folder1", [makeSavedQueryNode("/my/folder1/ws1")]),
+ makeSavedQueryNode("/my/ws2"),
]);
const expandedKeys = makeExpandedKeysRef(["/my"]);
@@ -437,8 +437,8 @@ const setupDefaultMocks = () => {
get editingNode() {
return editingNode.value;
},
- batchUpdateWorksheetFolders: vi.fn(),
- batchUpdateWorksheetFolderPaths: vi.fn(),
+ batchUpdateSavedQueryFolders: vi.fn(),
+ batchUpdateSavedQueryFolderPaths: vi.fn(),
setExpandedKeys: vi.fn(
(next: Set<string> | ((prev: Set<string>) => Set<string>)) => {
expandedKeys.value =
@@ -462,13 +462,13 @@ const setupDefaultMocks = () => {
get sheetTree() {
return viewContext._sheetTree.value;
},
- _sheetTree: { value: rootNode } as { value: WorksheetFolderNode },
+ _sheetTree: { value: rootNode } as { value: SavedQueryFolderNode },
fetchSheetList: vi.fn(),
fetchNextPage: vi.fn(),
- fetchWorksheetsByFolder: vi.fn(),
+ fetchSavedQueriesByFolder: vi.fn(),
rebuildTree: vi.fn(),
folderContext,
- getFoldersForWorksheet: vi.fn((path: string) => [path]),
+ getFoldersForSavedQuery: vi.fn((path: string) => [path]),
events: {
on: vi.fn(() => () => {}),
emit: vi.fn(),
@@ -477,7 +477,7 @@ const setupDefaultMocks = () => {
mocks.useSheetContext.mockReturnValue(sheetContext);
mocks.useSheetContextByView.mockReturnValue(viewContext);
- mocks.appStore.getWorksheetByName.mockImplementation((name: string) => ({
+ mocks.appStore.getSavedQueryByName.mockImplementation((name: string) => ({
name,
title: "My Query",
folders: [],
@@ -485,26 +485,26 @@ const setupDefaultMocks = () => {
starred: false,
creator: "users/[email protected]",
}));
- mocks.appStore.deleteWorksheetByName.mockResolvedValue(undefined);
- mocks.appStore.patchWorksheet.mockResolvedValue({});
- mocks.appStore.upsertWorksheetOrganizer.mockResolvedValue(undefined);
+ mocks.appStore.deleteSavedQueryByName.mockResolvedValue(undefined);
+ mocks.appStore.patchSavedQuery.mockResolvedValue({});
+ mocks.appStore.upsertSavedQueryOrganizer.mockResolvedValue(undefined);
mocks.getSQLEditorTabsState.mockReturnValue({
tabsById: new Map(),
closeTab: vi.fn(),
updateTab: vi.fn(),
setCurrentTabId: vi.fn(),
});
- mocks.createWorksheet.mockResolvedValue({});
+ mocks.createSavedQuery.mockResolvedValue({});
mocks.useDropdown.mockReturnValue({
currentNode: undefined,
options: [],
- worksheetEntity: undefined,
+ savedQueryEntity: undefined,
showSharePanel: false,
handleContextMenu: vi.fn(),
handleSharePanelShow: vi.fn(),
handleClickOutside: vi.fn(),
});
- mocks.openWorksheetByName.mockResolvedValue(undefined);
+ mocks.openSavedQueryByName.mockResolvedValue(undefined);
return {
rootNode,
@@ -598,18 +598,18 @@ describe("SheetTree", () => {
unmount();
});
- test("2. Click worksheet → fires openWorksheetByName", () => {
+ test("2. Click saved query → fires openSavedQueryByName", () => {
const defaultMocks = setupDefaultMocks();
- // Root node is a folder with a worksheet child
- const wsNode = makeWorksheetNode("/my/ws2");
+ // Root node is a folder with a saved query child
+ const wsNode = makeSavedQueryNode("/my/ws2");
const rootNode = makeFolderNode("/my", [wsNode]);
defaultMocks.viewContext._sheetTree.value = rootNode;
- // Make useDropdown return the worksheet node as current
+ // Make useDropdown return the saved query node as current
mocks.useDropdown.mockReturnValue({
currentNode: undefined,
options: [],
- worksheetEntity: undefined,
+ savedQueryEntity: undefined,
showSharePanel: false,
handleContextMenu: vi.fn(),
handleSharePanelShow: vi.fn(),
@@ -625,7 +625,7 @@ describe("SheetTree", () => {
);
render();
- // Find tree row for the worksheet node — it has data-item-key
+ // Find tree row for the saved query node — it has data-item-key
const row = container.querySelector(
`[data-item-key="/my/ws2"]`
) as HTMLElement | null;
@@ -637,9 +637,9 @@ describe("SheetTree", () => {
label?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
});
- expect(mocks.openWorksheetByName).toHaveBeenCalledWith(
+ expect(mocks.openSavedQueryByName).toHaveBeenCalledWith(
expect.objectContaining({
- worksheet: "worksheets/ws1",
+ savedQuery: "savedQueries/ws1",
forceNewTab: false,
})
);
@@ -683,7 +683,7 @@ describe("SheetTree", () => {
test("3b. Opening a locally nonempty folder still fetches its server members", () => {
const defaultMocks = setupDefaultMocks();
const folder = makeFolderNode("/my/folder1", [
- makeWorksheetNode("/my/folder1/new-local-ws"),
+ makeSavedQueryNode("/my/folder1/new-local-ws"),
]);
const rootNode = makeFolderNode("/my", [folder]);
defaultMocks.viewContext._sheetTree.value = rootNode;
@@ -706,7 +706,7 @@ describe("SheetTree", () => {
prefix?.dispatchEvent(new MouseEvent("click", { bubbles: true }));
});
- expect(defaultMocks.viewContext.fetchWorksheetsByFolder).toHaveBeenCalledWith(
+ expect(defaultMocks.viewContext.fetchSavedQueriesByFolder).toHaveBeenCalledWith(
"/my/folder1"
);
@@ -716,7 +716,7 @@ describe("SheetTree", () => {
test("3c. Already expanded locally nonempty folders are fetched", () => {
const defaultMocks = setupDefaultMocks();
const folder = makeFolderNode("/my/folder1", [
- makeWorksheetNode("/my/folder1/new-local-ws"),
+ makeSavedQueryNode("/my/folder1/new-local-ws"),
]);
const rootNode = makeFolderNode("/my", [folder]);
defaultMocks.viewContext._sheetTree.value = rootNode;
@@ -731,7 +731,7 @@ describe("SheetTree", () => {
);
render();
- expect(defaultMocks.viewContext.fetchWorksheetsByFolder).toHaveBeenCalledWith(
+ expect(defaultMocks.viewContext.fetchSavedQueriesByFolder).toHaveBeenCalledWith(
"/my/folder1"
);
@@ -740,7 +740,7 @@ describe("SheetTree", () => {
test("4. Multi-select mode renders checkboxes; toggle fires onCheckedNodesChange", () => {
const defaultMocks = setupDefaultMocks();
- const wsNode = makeWorksheetNode("/my/ws2");
+ const wsNode = makeSavedQueryNode("/my/ws2");
const rootNode = makeFolderNode("/my", [wsNode]);
defaultMocks.viewContext._sheetTree.value = rootNode;
@@ -782,9 +782,9 @@ describe("SheetTree", () => {
test("4b. Multi-select folder selection skips load-more nodes", () => {
const defaultMocks = setupDefaultMocks();
- const wsNode = makeWorksheetNode("/my/folder1/ws1");
+ const wsNode = makeSavedQueryNode("/my/folder1/ws1");
const loadMoreNode = makeLoadMoreNode(
- "__worksheet_load_more__:/my/folder1"
+ "__savedQuery_load_more__:/my/folder1"
);
const folderNode = makeFolderNode(
"/my/folder1",
@@ -826,7 +826,7 @@ describe("SheetTree", () => {
test("5. Right-click → opens context menu with items", () => {
const defaultMocks = setupDefaultMocks();
- const wsNode = makeWorksheetNode("/my/ws2");
+ const wsNode = makeSavedQueryNode("/my/ws2");
const rootNode = makeFolderNode("/my", [wsNode]);
defaultMocks.viewContext._sheetTree.value = rootNode;
@@ -837,7 +837,7 @@ describe("SheetTree", () => {
{ type: "item", key: "rename", label: "Rename" },
{ type: "item", key: "delete", label: "Delete" },
],
- worksheetEntity: undefined,
+ savedQueryEntity: undefined,
showSharePanel: false,
handleContextMenu,
handleSharePanelShow: vi.fn(),
@@ -876,19 +876,19 @@ describe("SheetTree", () => {
unmount();
});
- test("6. Delete confirm → fires worksheetV1Store.deleteWorksheetByName", async () => {
+ test("6. Delete confirm → fires savedQueryV1Store.deleteSavedQueryByName", async () => {
const defaultMocks = setupDefaultMocks();
- const wsNode = makeWorksheetNode("/my/ws2", "worksheets/ws2");
+ const wsNode = makeSavedQueryNode("/my/ws2", "savedQueries/ws2");
const rootNode = makeFolderNode("/my", [wsNode]);
defaultMocks.viewContext._sheetTree.value = rootNode;
- const deleteWorksheetByName = vi.fn().mockResolvedValue(undefined);
- mocks.appStore.deleteWorksheetByName = deleteWorksheetByName;
+ const deleteSavedQueryByName = vi.fn().mockResolvedValue(undefined);
+ mocks.appStore.deleteSavedQueryByName = deleteSavedQueryByName;
mocks.useDropdown.mockReturnValue({
currentNode: wsNode,
options: [{ type: "item", key: "delete", label: "Delete" }],
- worksheetEntity: { name: "worksheets/ws2" },
+ savedQueryEntity: { name: "savedQueries/ws2" },
showSharePanel: false,
handleContextMenu: vi.fn(),
handleSharePanelShow: vi.fn(),
@@ -934,21 +934,21 @@ describe("SheetTree", () => {
await new Promise((r) => setTimeout(r, 10));
});
- expect(deleteWorksheetByName).toHaveBeenCalledWith("worksheets/ws2");
+ expect(deleteSavedQueryByName).toHaveBeenCalledWith("savedQueries/ws2");
unmount();
});
test("6b. Delete folder moves all folder paths to root via batch folder update", async () => {
const defaultMocks = setupDefaultMocks();
- const loadedWorksheet = makeWorksheetNode(
+ const loadedSavedQuery = makeSavedQueryNode(
"/my/old/loaded",
- "worksheets/loaded"
+ "savedQueries/loaded"
);
- const oldFolder = makeFolderNode("/my/old", [loadedWorksheet]);
+ const oldFolder = makeFolderNode("/my/old", [loadedSavedQuery]);
const rootNode = makeFolderNode("/my", [oldFolder]);
defaultMocks.viewContext._sheetTree.value = rootNode;
- defaultMocks.viewContext.getFoldersForWorksheet.mockImplementation(
+ defaultMocks.viewContext.getFoldersForSavedQuery.mockImplementation(
(path: string) =>
path
.replace("/my", "")
@@ -964,7 +964,7 @@ describe("SheetTree", () => {
mocks.useDropdown.mockReturnValue({
currentNode: oldFolder,
options: [{ type: "item", key: "delete", label: "Delete" }],
- worksheetEntity: undefined,
+ savedQueryEntity: undefined,
showSharePanel: false,
handleContextMenu: vi.fn(),
handleSharePanelShow: vi.fn(),
@@ -1004,14 +1004,14 @@ describe("SheetTree", () => {
});
expect(
- defaultMocks.sheetContext.batchUpdateWorksheetFolderPaths
+ defaultMocks.sheetContext.batchUpdateSavedQueryFolderPaths
).toHaveBeenCalledWith("my", [
{ sourceFolder: ["old"], targetFolder: [] },
{ sourceFolder: ["old", "child"], targetFolder: [] },
{ sourceFolder: ["old", "child", "grand"], targetFolder: [] },
]);
expect(
- defaultMocks.sheetContext.batchUpdateWorksheetFolders
+ defaultMocks.sheetContext.batchUpdateSavedQueryFolders
).not.toHaveBeenCalled();
expect(defaultMocks.folderContext.removeFolder).toHaveBeenCalledWith(
"/my/old"
@@ -1025,7 +1025,7 @@ describe("SheetTree", () => {
const oldFolder = makeFolderNode("/my/old");
const rootNode = makeFolderNode("/my", [oldFolder]);
defaultMocks.viewContext._sheetTree.value = rootNode;
- defaultMocks.viewContext.getFoldersForWorksheet.mockImplementation(
+ defaultMocks.viewContext.getFoldersForSavedQuery.mockImplementation(
(path: string) =>
path
.replace("/my", "")
@@ -1040,7 +1040,7 @@ describe("SheetTree", () => {
mocks.useDropdown.mockReturnValue({
currentNode: oldFolder,
options: [{ type: "item", key: "delete", label: "Delete" }],
- worksheetEntity: undefined,
+ savedQueryEntity: undefined,
showSharePanel: false,
handleContextMenu: vi.fn(),
handleSharePanelShow: vi.fn(),
@@ -1067,7 +1067,7 @@ describe("SheetTree", () => {
});
expect(
- defaultMocks.sheetContext.batchUpdateWorksheetFolderPaths
+ defaultMocks.sheetContext.batchUpdateSavedQueryFolderPaths
).toHaveBeenCalledWith("my", [
{ sourceFolder: ["old"], targetFolder: [] },
{ sourceFolder: ["old", "child"], targetFolder: [] },
@@ -1083,7 +1083,7 @@ describe("SheetTree", () => {
const defaultMocks = setupDefaultMocks();
defaultMocks.viewContext._sheetTree.value = makeFolderNode("/my", [
{
- key: "__worksheet_load_more__:/my",
+ key: "__savedQuery_load_more__:/my",
label: "common.load-more",
editable: false,
isLeaf: true,
@@ -1103,7 +1103,7 @@ describe("SheetTree", () => {
render();
const loadMoreRow = container.querySelector(
- `[data-item-key="__worksheet_load_more__:/my"]`
+ `[data-item-key="__savedQuery_load_more__:/my"]`
) as HTMLElement | null;
expect(loadMoreRow).not.toBeNull();
const loadMoreWrapper = loadMoreRow?.querySelector(
@@ -1142,9 +1142,9 @@ describe("SheetTree", () => {
test("7b. Folder load more button fetches that folder's next page", async () => {
const defaultMocks = setupDefaultMocks();
const folder = makeFolderNode("/my/alpha", [
- makeWorksheetNode("/my/alpha/ws1"),
+ makeSavedQueryNode("/my/alpha/ws1"),
{
- key: "__worksheet_load_more__:/my/alpha",
+ key: "__savedQuery_load_more__:/my/alpha",
label: "common.load-more",
editable: false,
isLeaf: true,
@@ -1166,7 +1166,7 @@ describe("SheetTree", () => {
render();
const loadMoreRow = container.querySelector(
- `[data-item-key="__worksheet_load_more__:/my/alpha"]`
+ `[data-item-key="__savedQuery_load_more__:/my/alpha"]`
) as HTMLElement | null;
expect(loadMoreRow).not.toBeNull();
const loadMoreWrapper = loadMoreRow?.querySelector(
@@ -1206,7 +1206,7 @@ describe("SheetTree", () => {
test("7c. Load more rows are inert for tree actions", () => {
const defaultMocks = setupDefaultMocks();
- const loadMoreNode = makeLoadMoreNode("__worksheet_load_more__:/my");
+ const loadMoreNode = makeLoadMoreNode("__savedQuery_load_more__:/my");
const folderNode = makeFolderNode("/my/folder", [], true);
defaultMocks.viewContext._sheetTree.value = makeFolderNode("/my", [
folderNode,
@@ -1217,7 +1217,7 @@ describe("SheetTree", () => {
mocks.useDropdown.mockReturnValue({
currentNode: undefined,
options: [],
- worksheetEntity: undefined,
+ savedQueryEntity: undefined,
showSharePanel: false,
handleContextMenu,
handleSharePanelShow: vi.fn(),
@@ -1234,7 +1234,7 @@ describe("SheetTree", () => {
render();
const loadMoreRow = container.querySelector(
- `[data-item-key="__worksheet_load_more__:/my"]`
+ `[data-item-key="__savedQuery_load_more__:/my"]`
) as HTMLElement | null;
expect(loadMoreRow).not.toBeNull();
@@ -1246,15 +1246,15 @@ describe("SheetTree", () => {
expect(handleContextMenu).not.toHaveBeenCalled();
const disableDrag = mocks.treeProps.disableDrag as
- | ((data: { data: WorksheetFolderNode }) => boolean)
+ | ((data: { data: SavedQueryFolderNode }) => boolean)
| undefined;
expect(disableDrag?.({ data: loadMoreNode })).toBe(true);
expect(disableDrag?.({ data: folderNode })).toBe(false);
const disableDrop = mocks.treeProps.disableDrop as
| ((args: {
- parentNode?: { data: { data: WorksheetFolderNode } } | null;
- dragNodes: { data: { data: WorksheetFolderNode } }[];
+ parentNode?: { data: { data: SavedQueryFolderNode } } | null;
+ dragNodes: { data: { data: SavedQueryFolderNode } }[];
}) => boolean)
| undefined;
expect(
@@ -1276,7 +1276,7 @@ describe("SheetTree", () => {
test("7d. Add folder ignores load-more nodes when generating a name", async () => {
const defaultMocks = setupDefaultMocks();
const existingFolder = makeFolderNode("/my/new folder", [], true);
- const loadMoreNode = makeLoadMoreNode("__worksheet_load_more__:/my");
+ const loadMoreNode = makeLoadMoreNode("__savedQuery_load_more__:/my");
const rootNode = makeFolderNode(
"/my",
[existingFolder, loadMoreNode],
@@ -1287,7 +1287,7 @@ describe("SheetTree", () => {
mocks.useDropdown.mockReturnValue({
currentNode: rootNode,
options: [{ type: "item", key: "add-folder", label: "Add folder" }],
- worksheetEntity: undefined,
+ savedQueryEntity: undefined,
showSharePanel: false,
handleContextMenu: vi.fn(),
handleSharePanelShow: vi.fn(),
@@ -1325,7 +1325,7 @@ describe("SheetTree", () => {
test("8. Rename input is not clipped by display-mode row overflow", () => {
const defaultMocks = setupDefaultMocks();
- const wsNode = makeWorksheetNode("/my/ws-with-long-title");
+ const wsNode = makeSavedQueryNode("/my/ws-with-long-title");
const rootNode = makeFolderNode("/my", [wsNode]);
defaultMocks.viewContext._sheetTree.value = rootNode;
defaultMocks.editingNode.value = {
@@ -1422,7 +1422,7 @@ describe("SheetTree", () => {
node: oldFolder,
rawLabel: "new",
};
- defaultMocks.viewContext.getFoldersForWorksheet.mockImplementation(
+ defaultMocks.viewContext.getFoldersForSavedQuery.mockImplementation(
(path: string) =>
path
.replace("/my", "")
@@ -1454,7 +1454,7 @@ describe("SheetTree", () => {
});
expect(
- defaultMocks.sheetContext.batchUpdateWorksheetFolderPaths
+ defaultMocks.sheetContext.batchUpdateSavedQueryFolderPaths
).toHaveBeenCalledWith("my", [
{ sourceFolder: ["old"], targetFolder: ["new"] },
{ sourceFolder: ["old", "child"], targetFolder: ["new", "child"] },
@@ -1464,7 +1464,7 @@ describe("SheetTree", () => {
unmount();
});
- test("10. Opening an empty folder fetches that folder's worksheets", async () => {
+ test("10. Opening an empty folder fetches that folder's saved queries", async () => {
const defaultMocks = setupDefaultMocks();
const folder = makeFolderNode("/my/empty", []);
const rootNode = makeFolderNode("/my", [folder]);
@@ -1491,7 +1491,7 @@ describe("SheetTree", () => {
});
expect(
- defaultMocks.viewContext.fetchWorksheetsByFolder
+ defaultMocks.viewContext.fetchSavedQueriesByFolder
).toHaveBeenCalledWith("/my/empty");
unmount();
@@ -1517,7 +1517,7 @@ describe("SheetTree", () => {
});
expect(
- defaultMocks.viewContext.fetchWorksheetsByFolder
+ defaultMocks.viewContext.fetchSavedQueriesByFolder
).toHaveBeenCalledWith("/my/empty");
unmount();
diff --git a/frontend/src/modules/sql-editor/components/SheetTree.tsx b/frontend/src/modules/sql-editor/components/SheetTree.tsx
index 5f3ceeead6..d462ca1fe9 100644
--- a/frontend/src/modules/sql-editor/components/SheetTree.tsx
+++ b/frontend/src/modules/sql-editor/components/SheetTree.tsx
@@ -3,7 +3,7 @@
*
* Full feature parity with the Vue source (850 lines):
* 1. Tree display
- * 2. Click worksheet → open in editor
+ * 2. Click saved query → open in editor
* 3. Click folder → expand/collapse
* 4. Multi-select mode (checkbox column)
* 5. Drag-and-drop (wired via react-arborist onMove)
@@ -56,14 +56,14 @@ import { Tree } from "@/components/ui/tree";
import { countVisibleRows } from "@/components/ui/tree-utils";
import { cn } from "@/lib/utils";
import {
- openWorksheetByName,
+ openSavedQueryByName,
revealNodes,
- revealWorksheets,
+ revealSavedQueries,
+ type SavedQueryFolderNode,
+ type SavedQueryFolderPathUpdate,
type SheetViewMode,
useSheetContext,
useSheetContextByView,
- type WorksheetFolderNode,
- type WorksheetFolderPathUpdate,
} from "@/modules/sql-editor/model/Sheet";
import { useSQLEditorStore as useSQLEditorReactStore } from "@/modules/sql-editor/store";
import { useSQLEditorEditorState } from "@/modules/sql-editor/store/editor";
@@ -80,7 +80,7 @@ import { type DropdownOptionType, useDropdown } from "./useDropdown";
// ---------------------------------------------------------------------------
export type SheetTreeHandle = {
- handleMultiDelete: (nodes: WorksheetFolderNode[]) => Promise<void>;
+ handleMultiDelete: (nodes: SavedQueryFolderNode[]) => Promise<void>;
};
type Props = {
@@ -90,9 +90,9 @@ type Props = {
// "Multi-select" action is hidden so shared/draft rows cannot populate
// the `my` tree's checkedNodes (which feeds Delete + Move-to-folder).
readonly multiSelectMode?: boolean;
- readonly checkedNodes?: WorksheetFolderNode[];
+ readonly checkedNodes?: SavedQueryFolderNode[];
readonly onMultiSelectModeChange?: (next: boolean) => void;
- readonly onCheckedNodesChange?: (nodes: WorksheetFolderNode[]) => void;
+ readonly onCheckedNodesChange?: (nodes: SavedQueryFolderNode[]) => void;
readonly ref?: Ref<SheetTreeHandle>;
};
@@ -104,21 +104,21 @@ type DeleteDialogState =
| { type: "none" }
| {
type: "delete-sheet";
- worksheetName: string;
+ savedQueryName: string;
}
| {
type: "duplicate-sheet";
- worksheetName: string;
+ savedQueryName: string;
}
| {
type: "delete-folders";
folders: string[];
- worksheets: string[];
+ savedQueries: string[];
}
| {
type: "multi-delete";
folders: string[];
- worksheets: string[];
+ savedQueries: string[];
}
| {
type: "duplicate-folder-name";
@@ -132,8 +132,8 @@ type DeleteDialogState =
/** Build a flat→tree data structure for the Tree primitive. */
function toTreeData(
- node: WorksheetFolderNode
-): TreeDataNode<WorksheetFolderNode> {
+ node: SavedQueryFolderNode
+): TreeDataNode<SavedQueryFolderNode> {
return {
id: node.key,
data: node,
@@ -143,14 +143,14 @@ function toTreeData(
// Generate unique folder name based on existing children
// Returns "new folder", "new folder2", "new folder3", etc.
-function generateNewFolderName(children: WorksheetFolderNode[]): string {
+function generateNewFolderName(children: SavedQueryFolderNode[]): string {
const baseName = "new folder";
const regex = /^new folder(\d+)$/;
let maxNumber = 0;
for (let i = children.length - 1; i >= 0; i--) {
const child = children[i];
- if (child.worksheet || child.loadMore) {
+ if (child.savedQuery || child.loadMore) {
continue;
}
const match = child.label.match(regex);
@@ -167,18 +167,18 @@ function generateNewFolderName(children: WorksheetFolderNode[]): string {
return maxNumber === 0 ? baseName : `${baseName}${maxNumber + 1}`;
}
-function selectableNodes(node: WorksheetFolderNode[]): WorksheetFolderNode[];
-function selectableNodes(node: WorksheetFolderNode): WorksheetFolderNode[];
+function selectableNodes(node: SavedQueryFolderNode[]): SavedQueryFolderNode[];
+function selectableNodes(node: SavedQueryFolderNode): SavedQueryFolderNode[];
function selectableNodes(
- node: WorksheetFolderNode | WorksheetFolderNode[]
-): WorksheetFolderNode[] {
+ node: SavedQueryFolderNode | SavedQueryFolderNode[]
+): SavedQueryFolderNode[] {
if (Array.isArray(node)) {
return node.filter((n) => !n.loadMore);
}
return revealNodes(node, (n) => (n.loadMore ? undefined : n));
}
-function WorksheetTreeLoadMoreButton({
+function SavedQueryTreeLoadMoreButton({
label,
onClick,
}: Readonly<{
@@ -223,16 +223,16 @@ export function SheetTree({
const { t } = useTranslation();
// ---- Pinia stores (called at top level, not inside the Vue-bridge call) ----------
- const createWorksheet = useSQLEditorReactStore((s) => s.createWorksheet);
+ const createSavedQuery = useSQLEditorReactStore((s) => s.createSavedQuery);
// ---- Sheet contexts -------------------------------------------------------
const {
- filter: worksheetFilter,
+ filter: savedQueryFilter,
selectedKeys,
expandedKeys,
editingNode,
- batchUpdateWorksheetFolders,
- batchUpdateWorksheetFolderPaths,
+ batchUpdateSavedQueryFolders,
+ batchUpdateSavedQueryFolderPaths,
setExpandedKeys,
setEditingNode,
} = useSheetContext();
@@ -242,9 +242,9 @@ export function SheetTree({
sheetTree,
fetchSheetList,
fetchNextPage,
- fetchWorksheetsByFolder,
+ fetchSavedQueriesByFolder,
folderContext,
- getFoldersForWorksheet,
+ getFoldersForSavedQuery,
rebuildTree,
events,
} = useSheetContextByView(view);
@@ -259,16 +259,16 @@ export function SheetTree({
const {
currentNode: contextMenuNode,
options: dropdownOptions,
- worksheetEntity,
+ savedQueryEntity,
showSharePanel,
handleContextMenu,
handleSharePanelShow,
handleClickOutside: handleContextMenuClickOutside,
} = useDropdown(
view,
- worksheetFilter,
+ savedQueryFilter,
// Only expose the "Multi-select" entry when the parent wires the
- // multi-select callbacks — i.e. on the `my` tree inside WorksheetPane.
+ // multi-select callbacks — i.e. on the `my` tree inside SavedQueryPane.
!!onMultiSelectModeChange && !!onCheckedNodesChange
);
@@ -282,7 +282,7 @@ export function SheetTree({
const menuTriggerRef = useRef<HTMLButtonElement>(null);
const openMenuAtPoint = useCallback(
- (clientX: number, clientY: number, node: WorksheetFolderNode) => {
+ (clientX: number, clientY: number, node: SavedQueryFolderNode) => {
// flushSync so the trigger is repositioned before the synthetic click
// fires — otherwise Floating UI anchors against the previous position.
flushSync(() => {
@@ -301,7 +301,7 @@ export function SheetTree({
);
const openMenuAtElement = useCallback(
- (element: Element, node: WorksheetFolderNode) => {
+ (element: Element, node: SavedQueryFolderNode) => {
const rect = element.getBoundingClientRect();
flushSync(() => {
setMenuAnchorPos({ x: rect.right, y: rect.bottom });
@@ -319,7 +319,7 @@ export function SheetTree({
);
const openSharePanelAtElement = useCallback(
- (e: React.MouseEvent, node: WorksheetFolderNode) => {
+ (e: React.MouseEvent, node: SavedQueryFolderNode) => {
const rect = e.currentTarget.getBoundingClientRect();
setMenuAnchorPos({ x: rect.right, y: rect.bottom });
handleSharePanelShow(e, node);
@@ -376,7 +376,7 @@ export function SheetTree({
}, [editingKey, events, view]);
// ---- Tree data -----------------------------------------------------------
- const treeData = useMemo((): TreeDataNode<WorksheetFolderNode>[] => {
+ const treeData = useMemo((): TreeDataNode<SavedQueryFolderNode>[] => {
return [toTreeData(sheetTree)];
}, [sheetTree]);
@@ -387,7 +387,7 @@ export function SheetTree({
// AND the search filter — when the keyword is active, arborist hides
// non-matching rows, so the viewport should shrink accordingly.
const nodeMatches = useCallback(
- (node: WorksheetFolderNode, term: string): boolean =>
+ (node: SavedQueryFolderNode, term: string): boolean =>
filterNode(folderContext.rootPath)(term, node),
[folderContext.rootPath]
);
@@ -396,10 +396,10 @@ export function SheetTree({
countVisibleRows(
sheetTree,
new Set(expandedKeysArray),
- worksheetFilter.keyword,
+ savedQueryFilter.keyword,
nodeMatches
) * ROW_HEIGHT,
- [sheetTree, expandedKeysArray, worksheetFilter.keyword, nodeMatches]
+ [sheetTree, expandedKeysArray, savedQueryFilter.keyword, nodeMatches]
);
useEffect(() => {
@@ -407,18 +407,18 @@ export function SheetTree({
const expandedKeySet = new Set(expandedKeysArray);
for (const node of revealNodes(sheetTree, (node) => node)) {
if (
- node.worksheet ||
+ node.savedQuery ||
node.loadMore ||
node.key === folderContext.rootPath ||
!expandedKeySet.has(node.key)
) {
continue;
}
- void fetchWorksheetsByFolder(node.key);
+ void fetchSavedQueriesByFolder(node.key);
}
}, [
expandedKeysArray,
- fetchWorksheetsByFolder,
+ fetchSavedQueriesByFolder,
folderContext.rootPath,
isInitialized,
isLoading,
@@ -428,15 +428,15 @@ export function SheetTree({
// ---- Expand/collapse toggle -----------------------------------------------
const handleToggleExpand = useCallback(
- (node: WorksheetFolderNode) => {
+ (node: SavedQueryFolderNode) => {
const isOpening = !expandedKeysArray.includes(node.key);
if (
isOpening &&
- !node.worksheet &&
+ !node.savedQuery &&
!node.loadMore &&
node.key !== folderContext.rootPath
) {
- void fetchWorksheetsByFolder(node.key);
+ void fetchSavedQueriesByFolder(node.key);
}
setExpandedKeys((prev) => {
const next = new Set(prev);
@@ -450,7 +450,7 @@ export function SheetTree({
},
[
expandedKeysArray,
- fetchWorksheetsByFolder,
+ fetchSavedQueriesByFolder,
folderContext.rootPath,
setExpandedKeys,
]
@@ -460,9 +460,9 @@ export function SheetTree({
const findParentNode = useCallback(
(
- root: WorksheetFolderNode,
+ root: SavedQueryFolderNode,
key: string
- ): WorksheetFolderNode | undefined => {
+ ): SavedQueryFolderNode | undefined => {
if (root.key === key) return undefined;
for (const child of root.children) {
if (child.key === key) return root;
@@ -496,25 +496,28 @@ export function SheetTree({
[setExpandedKeys, folderContext]
);
- const updateWorksheetFolders = useCallback(
+ const updateSavedQueryFolders = useCallback(
async (
- node: WorksheetFolderNode,
+ node: SavedQueryFolderNode,
oldParentKey: string,
newParentKey: string
) => {
- const worksheets = revealWorksheets(node, (n: WorksheetFolderNode) => {
- if (n.worksheet) {
- const newFullPath = n.key.replace(oldParentKey, newParentKey);
- return {
- name: n.worksheet.name,
- folders: getFoldersForWorksheet(newFullPath),
- };
+ const savedQueries = revealSavedQueries(
+ node,
+ (n: SavedQueryFolderNode) => {
+ if (n.savedQuery) {
+ const newFullPath = n.key.replace(oldParentKey, newParentKey);
+ return {
+ name: n.savedQuery.name,
+ folders: getFoldersForSavedQuery(newFullPath),
+ };
+ }
+ return undefined;
}
- return undefined;
- });
- await batchUpdateWorksheetFolders(worksheets);
+ );
+ await batchUpdateSavedQueryFolders(savedQueries);
},
- [batchUpdateWorksheetFolders, getFoldersForWorksheet]
+ [batchUpdateSavedQueryFolders, getFoldersForSavedQuery]
);
const collectFolderKeys = useCallback(
@@ -529,22 +532,22 @@ export function SheetTree({
const updateFolderFolders = useCallback(
async (oldKey: string, newKey: string) => {
- const updates = collectFolderKeys(oldKey).map<WorksheetFolderPathUpdate>(
+ const updates = collectFolderKeys(oldKey).map<SavedQueryFolderPathUpdate>(
(sourceKey) => ({
- sourceFolder: getFoldersForWorksheet(sourceKey),
- targetFolder: getFoldersForWorksheet(
+ sourceFolder: getFoldersForSavedQuery(sourceKey),
+ targetFolder: getFoldersForSavedQuery(
sourceKey === oldKey
? newKey
: sourceKey.replace(`${oldKey}/`, `${newKey}/`)
),
})
);
- await batchUpdateWorksheetFolderPaths(view, updates);
+ await batchUpdateSavedQueryFolderPaths(view, updates);
},
[
- batchUpdateWorksheetFolderPaths,
+ batchUpdateSavedQueryFolderPaths,
collectFolderKeys,
- getFoldersForWorksheet,
+ getFoldersForSavedQuery,
view,
]
);
@@ -557,33 +560,35 @@ export function SheetTree({
folderKeys.add(key);
}
}
- const updates = [...folderKeys].map<WorksheetFolderPathUpdate>((key) => ({
- sourceFolder: getFoldersForWorksheet(key),
- targetFolder: [],
- }));
+ const updates = [...folderKeys].map<SavedQueryFolderPathUpdate>(
+ (key) => ({
+ sourceFolder: getFoldersForSavedQuery(key),
+ targetFolder: [],
+ })
+ );
if (updates.length === 0) return;
- await batchUpdateWorksheetFolderPaths(view, updates);
+ await batchUpdateSavedQueryFolderPaths(view, updates);
},
[
- batchUpdateWorksheetFolderPaths,
+ batchUpdateSavedQueryFolderPaths,
collectFolderKeys,
- getFoldersForWorksheet,
+ getFoldersForSavedQuery,
view,
]
);
// ---- Delete helpers -------------------------------------------------------
- const doDeleteWorksheets = useCallback(async (worksheets: string[]) => {
+ const doDeleteSavedQueries = useCallback(async (savedQueries: string[]) => {
await Promise.all(
- worksheets.map((worksheet) =>
- useAppStore.getState().deleteWorksheetByName(worksheet)
+ savedQueries.map((savedQuery) =>
+ useAppStore.getState().deleteSavedQueryByName(savedQuery)
)
);
const tabsState = getSQLEditorTabsState();
- for (const worksheet of worksheets) {
+ for (const savedQuery of savedQueries) {
const tab = Array.from(tabsState.tabsById.values()).find(
- (t) => t.worksheet === worksheet
+ (t) => t.savedQuery === savedQuery
);
if (tab) {
tabsState.closeTab(tab.id);
@@ -611,9 +616,9 @@ export function SheetTree({
// original (the immer-frozen tree node is never mutated in place).
const newTitle = editing.rawLabel.trim();
// Folders can't be renamed to empty (the label IS the folder name and the
- // key segment). Worksheets can — they fall back to the "Untitled"
+ // key segment). SavedQueries can — they fall back to the "Untitled"
// placeholder in the UI.
- if (!newTitle && !editing.node.worksheet) {
+ if (!newTitle && !editing.node.savedQuery) {
// Empty folder name — abort the rename, leave the node untouched.
cleanup();
return;
@@ -626,20 +631,20 @@ export function SheetTree({
return;
}
- if (editing.node.worksheet) {
- const worksheet = useAppStore
+ if (editing.node.savedQuery) {
+ const savedQuery = useAppStore
.getState()
- .getWorksheetByName(editing.node.worksheet.name);
- if (!worksheet) {
+ .getSavedQueryByName(editing.node.savedQuery.name);
+ if (!savedQuery) {
cleanup();
return;
}
await useAppStore
.getState()
- .patchWorksheet({ ...worksheet, title: newTitle }, ["title"]);
+ .patchSavedQuery({ ...savedQuery, title: newTitle }, ["title"]);
const tabsState = getSQLEditorTabsState();
const tab = Array.from(tabsState.tabsById.values()).find(
- (t) => t.worksheet === worksheet.name
+ (t) => t.savedQuery === savedQuery.name
);
if (tab) {
tabsState.updateTab(tab.id, { title: newTitle });
@@ -724,21 +729,21 @@ export function SheetTree({
// ---- Click handler -------------------------------------------------------
const handleNodeClick = useCallback(
- (e: React.MouseEvent, node: WorksheetFolderNode) => {
+ (e: React.MouseEvent, node: SavedQueryFolderNode) => {
if (editingNode) return;
if (node.loadMore) {
void fetchNextPage(node.loadMoreFolderKey);
return;
}
- if (node.worksheet) {
- if (node.worksheet.type === "worksheet") {
- void openWorksheetByName({
- worksheet: node.worksheet.name,
+ if (node.savedQuery) {
+ if (node.savedQuery.type === "savedQuery") {
+ void openSavedQueryByName({
+ savedQuery: node.savedQuery.name,
forceNewTab: e.metaKey || e.ctrlKey,
});
} else {
// draft tab
- getSQLEditorTabsState().setCurrentTabId(node.worksheet.name);
+ getSQLEditorTabsState().setCurrentTabId(node.savedQuery.name);
}
} else {
handleToggleExpand(node);
@@ -748,14 +753,14 @@ export function SheetTree({
);
// ---- Duplicate sheet -------------------------------------------------------
- const handleDuplicateSheet = useCallback((worksheetName: string) => {
- setDeleteDialogState({ type: "duplicate-sheet", worksheetName });
+ const handleDuplicateSheet = useCallback((savedQueryName: string) => {
+ setDeleteDialogState({ type: "duplicate-sheet", savedQueryName });
}, []);
// ---- handleDeleteFolders -------------------------------------------------
// Returns a promise that resolves true if deletion happened, false if cancelled.
const handleDeleteFolders = useCallback(
- (folders: string[], worksheets: string[]): Promise<boolean> => {
+ (folders: string[], savedQueries: string[]): Promise<boolean> => {
return new Promise<boolean>((resolve) => {
const cleanFolders = () => {
for (const folder of folders) {
@@ -763,7 +768,7 @@ export function SheetTree({
}
};
- if (worksheets.length === 0) {
+ if (savedQueries.length === 0) {
void (async () => {
await moveFoldersToRoot(folders);
cleanFolders();
@@ -776,12 +781,16 @@ export function SheetTree({
setDeleteDialogState({
type: "delete-folders",
folders,
- worksheets,
+ savedQueries,
});
// The dialog will call resolve via the dialog-specific actions below.
// We stash resolve in a ref so the dialog buttons can pick it up.
- deleteFoldersResolveRef.current = { resolve, cleanFolders, worksheets };
+ deleteFoldersResolveRef.current = {
+ resolve,
+ cleanFolders,
+ savedQueries,
+ };
});
},
[folderContext, moveFoldersToRoot]
@@ -791,20 +800,20 @@ export function SheetTree({
const deleteFoldersResolveRef = useRef<{
resolve: (v: boolean) => void;
cleanFolders: () => void;
- worksheets: string[];
+ savedQueries: string[];
} | null>(null);
// ---- handleMultiDelete (exposed via ref) ---------------------------------
const handleMultiDelete = useCallback(
- (nodes: WorksheetFolderNode[]): Promise<void> => {
+ (nodes: SavedQueryFolderNode[]): Promise<void> => {
const folders: string[] = [];
- const worksheets: string[] = [];
+ const savedQueries: string[] = [];
for (const node of nodes) {
if (node.loadMore) {
continue;
}
- if (node.worksheet) {
- worksheets.push(node.worksheet.name);
+ if (node.savedQuery) {
+ savedQueries.push(node.savedQuery.name);
continue;
}
if (node.key === folderContext.rootPath) {
@@ -822,17 +831,17 @@ export function SheetTree({
}
folders.push(node.key);
}
- if (folders.length === 0 && worksheets.length === 0) {
+ if (folders.length === 0 && savedQueries.length === 0) {
return Promise.resolve();
}
// Multi-select is explicit: delete exactly what was checked. Checking a
// folder already auto-includes its descendants, so the selection captures
// the user's full intent. We must NOT reuse the folder context-menu's
// "Non-empty folder → move to root vs delete" prompt here — that prompt
- // exists for deleting a single folder whose worksheets weren't selected.
+ // exists for deleting a single folder whose saved queries weren't selected.
return new Promise<void>((resolve) => {
multiDeleteResolveRef.current = resolve;
- setDeleteDialogState({ type: "multi-delete", folders, worksheets });
+ setDeleteDialogState({ type: "multi-delete", folders, savedQueries });
});
},
[folderContext]
@@ -841,7 +850,7 @@ export function SheetTree({
// Ref to hold the pending promise resolve for the multi-delete dialog.
const multiDeleteResolveRef = useRef<(() => void) | null>(null);
- // Expose handleMultiDelete via an imperative ref so WorksheetPane can call it
+ // Expose handleMultiDelete via an imperative ref so SavedQueryPane can call it
useImperativeHandle(ref, () => ({ handleMultiDelete }), [handleMultiDelete]);
// ---- Context menu select handler -----------------------------------------
@@ -868,22 +877,22 @@ export function SheetTree({
// Focus happens via useEffect above
break;
case "delete":
- if (contextMenuNode.worksheet) {
+ if (contextMenuNode.savedQuery) {
setDeleteDialogState({
type: "delete-sheet",
- worksheetName: contextMenuNode.worksheet.name,
+ savedQueryName: contextMenuNode.savedQuery.name,
});
} else {
- const worksheets = revealWorksheets(
+ const savedQueries = revealSavedQueries(
contextMenuNode,
- (n) => n.worksheet?.name
+ (n) => n.savedQuery?.name
);
- void handleDeleteFolders([contextMenuNode.key], worksheets);
+ void handleDeleteFolders([contextMenuNode.key], savedQueries);
}
break;
case "duplicate":
- if (contextMenuNode.worksheet) {
- await handleDuplicateSheet(contextMenuNode.worksheet.name);
+ if (contextMenuNode.savedQuery) {
+ await handleDuplicateSheet(contextMenuNode.savedQuery.name);
}
break;
case "add-folder": {
@@ -907,9 +916,9 @@ export function SheetTree({
});
break;
}
- case "add-worksheet":
- await createWorksheet({
- folders: getFoldersForWorksheet(contextMenuNode.key),
+ case "add-saved-query":
+ await createSavedQuery({
+ folders: getFoldersForSavedQuery(contextMenuNode.key),
});
break;
case "multi-select":
@@ -932,8 +941,8 @@ export function SheetTree({
setEditingNode,
setExpandedKeys,
folderContext,
- getFoldersForWorksheet,
- createWorksheet,
+ getFoldersForSavedQuery,
+ createSavedQuery,
handleDeleteFolders,
handleDuplicateSheet,
handleSharePanelShow,
@@ -942,17 +951,17 @@ export function SheetTree({
]
);
- // ---- handleWorksheetToggleStar (debounced) --------------------------------
+ // ---- handleSavedQueryToggleStar (debounced) --------------------------------
const starTimerRef = useRef<ReturnType<typeof setTimeout> | null>(null);
- const handleWorksheetToggleStar = useCallback(
- ({ worksheet, starred }: { worksheet: string; starred: boolean }) => {
+ const handleSavedQueryToggleStar = useCallback(
+ ({ savedQuery, starred }: { savedQuery: string; starred: boolean }) => {
if (starTimerRef.current !== null) {
clearTimeout(starTimerRef.current);
}
starTimerRef.current = setTimeout(() => {
void useAppStore
.getState()
- .upsertWorksheetOrganizer({ worksheet, starred }, ["starred"]);
+ .upsertSavedQueryOrganizer({ savedQuery, starred }, ["starred"]);
}, 300);
},
[]
@@ -961,7 +970,7 @@ export function SheetTree({
// ---- handleDuplicateFolderNameDrop: promise-based duplicate check for DnD --
// Mirrors Vue's handleDuplicateFolderName: resolves true (merge) or false (cancel).
const handleDuplicateFolderNameDrop = useCallback(
- (parentNode: WorksheetFolderNode, newKey: string): Promise<boolean> => {
+ (parentNode: SavedQueryFolderNode, newKey: string): Promise<boolean> => {
const sameNode = parentNode.children.find(
(child) => child.key === newKey
);
@@ -983,17 +992,17 @@ export function SheetTree({
// Mirrors Vue's handleDrop. react-arborist provides the destination parentNode
// (always a folder — arborist resolves drop-on-leaf to its parent) and an
// array of dragged nodes. Only single-drag is supported (matches Vue).
- const handleMove: MoveHandler<TreeDataNode<WorksheetFolderNode>> =
+ const handleMove: MoveHandler<TreeDataNode<SavedQueryFolderNode>> =
useCallback(
async ({ dragNodes, parentNode: arboristParent }) => {
// Resolve the destination folder node
- let parentFolderNode: WorksheetFolderNode | undefined;
+ let parentFolderNode: SavedQueryFolderNode | undefined;
if (arboristParent === null) {
// Dropped at root level — use the root of sheetTree
parentFolderNode = sheetTree;
} else {
const candidate = arboristParent.data.data;
- if (candidate.worksheet) {
+ if (candidate.savedQuery) {
// Should not happen given disableDrop predicate, but guard anyway.
parentFolderNode = findParentNode(sheetTree, candidate.key);
} else {
@@ -1004,7 +1013,7 @@ export function SheetTree({
// Only handle single drag (matches Vue behaviour)
const draggedTreeNode = dragNodes[0] as
- | NodeApi<TreeDataNode<WorksheetFolderNode>>
+ | NodeApi<TreeDataNode<SavedQueryFolderNode>>
| undefined;
if (!draggedTreeNode) return;
@@ -1029,10 +1038,10 @@ export function SheetTree({
if (!merge) return;
const shouldCloseOldParent =
- !draggedNode.worksheet && oldParentNode.children.length === 1;
+ !draggedNode.savedQuery && oldParentNode.children.length === 1;
- if (draggedNode.worksheet) {
- await updateWorksheetFolders(
+ if (draggedNode.savedQuery) {
+ await updateSavedQueryFolders(
draggedNode,
oldParentNode.key,
parentFolderNode.key
@@ -1062,7 +1071,7 @@ export function SheetTree({
findParentNode,
folderContext,
handleDuplicateFolderNameDrop,
- updateWorksheetFolders,
+ updateSavedQueryFolders,
updateFolderFolders,
rebuildTree,
replaceExpandedKeys,
@@ -1072,7 +1081,7 @@ export function SheetTree({
// ---- Search match for Tree primitive ------------------------------------
const searchMatch = useCallback(
- (node: TreeDataNode<WorksheetFolderNode>, term: string): boolean => {
+ (node: TreeDataNode<SavedQueryFolderNode>, term: string): boolean => {
const pred = filterNode(folderContext.rootPath);
return pred(term, node.data);
},
@@ -1088,7 +1097,7 @@ export function SheetTree({
}: {
node: {
id: string;
- data: TreeDataNode<WorksheetFolderNode>;
+ data: TreeDataNode<SavedQueryFolderNode>;
isSelected: boolean;
isOpen?: boolean;
willReceiveDrop?: boolean;
@@ -1104,7 +1113,9 @@ export function SheetTree({
!!editingNode && editingNode.node.key === folderNode.key;
const isChecked = checkedNodes.some((n) => n.key === folderNode.key);
const isDropTargetFolder =
- !folderNode.worksheet && !folderNode.loadMore && !!node.willReceiveDrop;
+ !folderNode.savedQuery &&
+ !folderNode.loadMore &&
+ !!node.willReceiveDrop;
// react-arborist injects `paddingLeft: level * indent` via `style`,
// which overrides `className`'s `px-2` padding-left. Merge indent with
@@ -1159,7 +1170,7 @@ export function SheetTree({
onCheckedChange={(checked) => {
// Checking a folder recursively includes all descendants so
// users don't have to tick each child individually.
- const affected = folderNode.worksheet
+ const affected = folderNode.savedQuery
? [folderNode]
: selectableNodes(folderNode);
if (checked) {
@@ -1191,7 +1202,7 @@ export function SheetTree({
)}
{folderNode.loadMore ? (
- <WorksheetTreeLoadMoreButton
+ <SavedQueryTreeLoadMoreButton
label={folderNode.label}
onClick={(e) => {
e.stopPropagation();
@@ -1232,7 +1243,7 @@ export function SheetTree({
const val = e.target.value;
const { selectionStart, selectionEnd } = e.currentTarget;
if (!editingNode) return;
- if (!editingNode.node.worksheet) {
+ if (!editingNode.node.savedQuery) {
// folder names cannot contain "/" or "."
if (val.includes("/") || val.includes(".")) return;
}
@@ -1241,19 +1252,24 @@ export function SheetTree({
}}
onClick={(e) => e.stopPropagation()}
/>
- ) : folderNode.worksheet && !folderNode.label ? (
- // Untitled worksheet — render a placeholder. We don't pipe this
- // through HighlightLabelText since there's nothing to highlight
- // and the muted italic styling signals "empty title".
- <span className="truncate block text-control-placeholder italic">
- {t("common.untitled")}
- </span>
) : (
- <HighlightLabelText
- text={folderNode.label}
- keyword={worksheetFilter.keyword}
- className="truncate block"
- />
+ <>
+ {folderNode.savedQuery && !folderNode.label ? (
+ // Untitled saved query — render a placeholder. We don't
+ // pipe this through HighlightLabelText since there's
+ // nothing to highlight and the muted italic styling
+ // signals "empty title".
+ <span className="truncate block text-control-placeholder italic">
+ {t("common.untitled")}
+ </span>
+ ) : (
+ <HighlightLabelText
+ text={folderNode.label}
+ keyword={savedQueryFilter.keyword}
+ className="truncate block"
+ />
+ )}
+ </>
)}
</span>
)}
@@ -1267,7 +1283,7 @@ export function SheetTree({
onContextMenuShow={(e, n) =>
openMenuAtElement(e.currentTarget, n)
}
- onToggleStar={handleWorksheetToggleStar}
+ onToggleStar={handleSavedQueryToggleStar}
/>
)}
</div>
@@ -1280,13 +1296,13 @@ export function SheetTree({
setEditingNode,
checkedNodes,
multiSelectMode,
- worksheetFilter,
+ savedQueryFilter,
view,
folderContext,
handleNodeClick,
handleRenameNode,
restoreRenameInputSelection,
- handleWorksheetToggleStar,
+ handleSavedQueryToggleStar,
openMenuAtPoint,
openMenuAtElement,
openSharePanelAtElement,
@@ -1327,9 +1343,9 @@ export function SheetTree({
size="sm"
onClick={async () => {
if (deleteDialogState.type !== "delete-sheet") return;
- const { worksheetName } = deleteDialogState;
+ const { savedQueryName } = deleteDialogState;
setDeleteDialogState({ type: "none" });
- await doDeleteWorksheets([worksheetName]);
+ await doDeleteSavedQueries([savedQueryName]);
}}
>
{t("common.delete")}
@@ -1363,16 +1379,16 @@ export function SheetTree({
size="sm"
onClick={async () => {
if (deleteDialogState.type !== "duplicate-sheet") return;
- const { worksheetName } = deleteDialogState;
+ const { savedQueryName } = deleteDialogState;
setDeleteDialogState({ type: "none" });
- const worksheet = useAppStore
+ const savedQuery = useAppStore
.getState()
- .getWorksheetByName(worksheetName);
- if (!worksheet) return;
- await createWorksheet({
- title: worksheet.title,
- folders: worksheet.folders,
- database: worksheet.database,
+ .getSavedQueryByName(savedQueryName);
+ if (!savedQuery) return;
+ await createSavedQuery({
+ title: savedQuery.title,
+ folders: savedQuery.folders,
+ database: savedQuery.database,
});
useAppStore.getState().notify({
module: "bytebase",
@@ -1444,19 +1460,19 @@ export function SheetTree({
size="sm"
onClick={async () => {
if (deleteDialogState.type !== "delete-folders") return;
- const { worksheets } = deleteDialogState;
+ const { savedQueries } = deleteDialogState;
setDeleteDialogState({ type: "none" });
const pending = deleteFoldersResolveRef.current;
if (pending) {
// TODO: This only deletes files already loaded into the tree.
// Add a batch delete-by-folder API before treating this as
// "delete all files" for paginated folders.
- await doDeleteWorksheets(worksheets);
+ await doDeleteSavedQueries(savedQueries);
pending.cleanFolders();
pending.resolve(true);
deleteFoldersResolveRef.current = null;
} else {
- await doDeleteWorksheets(worksheets);
+ await doDeleteSavedQueries(savedQueries);
for (const folder of folderContext.rootPath ? [] : []) {
folderContext.removeFolder(folder);
}
@@ -1498,10 +1514,10 @@ export function SheetTree({
size="sm"
onClick={async () => {
if (deleteDialogState.type !== "multi-delete") return;
- const { folders, worksheets } = deleteDialogState;
+ const { folders, savedQueries } = deleteDialogState;
setDeleteDialogState({ type: "none" });
- if (worksheets.length > 0) {
- await doDeleteWorksheets(worksheets);
+ if (savedQueries.length > 0) {
+ await doDeleteSavedQueries(savedQueries);
}
for (const folder of folders) {
folderContext.removeFolder(folder);
@@ -1569,13 +1585,16 @@ export function SheetTree({
// ---- Main render ---------------------------------------------------------
return (
- <div className="relative flex min-w-0 max-w-full flex-col items-stretch gap-y-1 overflow-x-clip worksheet-tree">
- <Tree<WorksheetFolderNode>
+ <div
+ data-testid="saved-query-tree"
+ className="relative flex min-w-0 max-w-full flex-col items-stretch gap-y-1 overflow-x-clip"
+ >
+ <Tree<SavedQueryFolderNode>
data={treeData}
renderNode={renderNode}
selectedIds={selectedKeys}
expandedIds={expandedKeysArray}
- searchTerm={worksheetFilter.keyword}
+ searchTerm={savedQueryFilter.keyword}
searchMatch={searchMatch}
height={treeHeight}
rowHeight={ROW_HEIGHT}
@@ -1597,7 +1616,7 @@ export function SheetTree({
view === "draft" || !!editingNode || multiSelectMode
? true
: ({ parentNode: p, dragNodes }) =>
- !!p?.data.data.worksheet ||
+ !!p?.data.data.savedQuery ||
!!p?.data.data.loadMore ||
dragNodes.some((node) => !!node.data.data.loadMore)
}
@@ -1607,7 +1626,7 @@ export function SheetTree({
menu (the row's More button or the cursor). Opens when the user
selects "Share" from the context menu or clicks the Users badge. */}
<Popover
- open={showSharePanel && !!worksheetEntity}
+ open={showSharePanel && !!savedQueryEntity}
onOpenChange={(next) => {
if (!next) handleContextMenuClickOutside();
}}
@@ -1629,7 +1648,9 @@ export function SheetTree({
}
/>
<PopoverContent align="start" sideOffset={4}>
- {worksheetEntity && <SharePopoverBody worksheet={worksheetEntity} />}
+ {savedQueryEntity && (
+ <SharePopoverBody savedQuery={savedQueryEntity} />
+ )}
</PopoverContent>
</Popover>
diff --git a/frontend/src/modules/sql-editor/components/StandardPanel/EditorMain.tsx b/frontend/src/modules/sql-editor/components/StandardPanel/EditorMain.tsx
index bddbf8390e..f1b70d4c63 100644
--- a/frontend/src/modules/sql-editor/components/StandardPanel/EditorMain.tsx
+++ b/frontend/src/modules/sql-editor/components/StandardPanel/EditorMain.tsx
@@ -27,7 +27,7 @@ interface EditorMainProps {
/**
* React port of `frontend/src/views/sql-editor/EditorPanel/StandardPanel/EditorMain.vue`.
*
- * Worksheet shell:
+ * SavedQuery shell:
* - Top toolbar (`EditorAction`, already React)
* - Body: `SQLEditor` when there's a tab, `Welcome` otherwise
* - Two hidden React modal mounts (`ExecutingHintModal`, `SaveSheetModal`)
diff --git a/frontend/src/modules/sql-editor/components/StandardPanel/SQLEditor.tsx b/frontend/src/modules/sql-editor/components/StandardPanel/SQLEditor.tsx
index 8a4aa839cb..0d8978bb30 100644
--- a/frontend/src/modules/sql-editor/components/StandardPanel/SQLEditor.tsx
+++ b/frontend/src/modules/sql-editor/components/StandardPanel/SQLEditor.tsx
@@ -12,7 +12,7 @@ import {
extensionNameOfLanguage,
formatEditorContent,
} from "@/components/monaco/utils";
-import { useWorksheetAndTab } from "@/hooks/useWorksheetAndTab";
+import { useSavedQueryAndTab } from "@/hooks/useSavedQueryAndTab";
import { aiContextEvents } from "@/modules/ai/logic";
import * as promptUtils from "@/modules/ai/logic/prompt";
import type { ChatAction } from "@/modules/ai/types";
@@ -52,7 +52,7 @@ interface SQLEditorProps {
/**
* React port of `frontend/src/views/sql-editor/EditorPanel/StandardPanel/SQLEditor.vue`.
*
- * Worksheet Monaco editor with full keybinding parity:
+ * SavedQuery Monaco editor with full keybinding parity:
* - Cmd+Enter run / Cmd+Shift+Enter run-in-new-tab
* - Cmd+S save sheet
* - Cmd+E explain (or "Dry Run" for BigQuery)
@@ -69,7 +69,7 @@ interface SQLEditorProps {
* is run from the toolbar.
*/
export function SQLEditor({ onExecute }: SQLEditorProps) {
- const { isReadOnly: readonly } = useWorksheetAndTab();
+ const { isReadOnly: readonly } = useSavedQueryAndTab();
const setShowAIPanel = useSQLEditorStore((s) => s.setShowAIPanel);
const setPendingInsertAtCaret = useSQLEditorStore(
(s) => s.setPendingInsertAtCaret
diff --git a/frontend/src/modules/sql-editor/components/StandardPanel/StandardPanel.tsx b/frontend/src/modules/sql-editor/components/StandardPanel/StandardPanel.tsx
index 75c0405755..358855ba6b 100644
--- a/frontend/src/modules/sql-editor/components/StandardPanel/StandardPanel.tsx
+++ b/frontend/src/modules/sql-editor/components/StandardPanel/StandardPanel.tsx
@@ -33,7 +33,7 @@ const AIPaneFallback = () => (
/**
* React port of `frontend/src/views/sql-editor/EditorPanel/StandardPanel/StandardPanel.vue`.
*
- * Worksheet-mode editor host. Layout, ordered top-to-bottom:
+ * SavedQuery-mode editor host. Layout, ordered top-to-bottom:
* 1. Optional outer vertical split — editor / `<ResultPanel>`.
* Only rendered when the underlying instance supports read-only
* queries (mirrors the Vue `showResultPanel` gate that prevents
@@ -65,7 +65,7 @@ export function StandardPanel() {
const editorPanelSize = useSQLEditorStore(useShallow(selectEditorPanelSize));
const instanceHasReadonly = instanceV1HasReadonlyMode(instance);
- if (tab && tab.mode !== "WORKSHEET") {
+ if (tab && tab.mode !== "SAVED_QUERY") {
return null;
}
diff --git a/frontend/src/modules/sql-editor/components/TabContextMenu.tsx b/frontend/src/modules/sql-editor/components/TabContextMenu.tsx
index 3b4e5031cf..112b7c0765 100644
--- a/frontend/src/modules/sql-editor/components/TabContextMenu.tsx
+++ b/frontend/src/modules/sql-editor/components/TabContextMenu.tsx
@@ -78,7 +78,8 @@ export const TabContextMenu = forwardRef<TabContextMenuHandle>(
};
const showRename =
- target?.tab.mode === "WORKSHEET" && target?.tab.viewState.view === "CODE";
+ target?.tab.mode === "SAVED_QUERY" &&
+ target?.tab.viewState.view === "CODE";
return (
<DropdownMenu
diff --git a/frontend/src/modules/sql-editor/components/TabItem.test.tsx b/frontend/src/modules/sql-editor/components/TabItem.test.tsx
index 7643b17f5e..193a5bb480 100644
--- a/frontend/src/modules/sql-editor/components/TabItem.test.tsx
+++ b/frontend/src/modules/sql-editor/components/TabItem.test.tsx
@@ -10,7 +10,7 @@ import { beforeEach, describe, expect, test, vi } from "vitest";
const mocks = vi.hoisted(() => ({
useTranslation: vi.fn(() => ({ t: (key: string) => key })),
useSQLEditorStore: vi.fn(),
- currentAsidePanelTab: "WORKSHEET" as string,
+ currentAsidePanelTab: "SAVED_QUERY" as string,
}));
vi.mock("react-i18next", () => ({
@@ -49,7 +49,7 @@ const renderIntoContainer = (element: ReactElement) => {
beforeEach(async () => {
vi.clearAllMocks();
- mocks.currentAsidePanelTab = "WORKSHEET";
+ mocks.currentAsidePanelTab = "SAVED_QUERY";
mocks.useSQLEditorStore.mockImplementation(
(selector: (s: { asidePanelTab: string }) => unknown) =>
selector({ asidePanelTab: mocks.currentAsidePanelTab })
@@ -58,12 +58,12 @@ beforeEach(async () => {
});
describe("TabItem", () => {
- test("renders label for WORKSHEET tab", () => {
+ test("renders label for SAVED_QUERY tab", () => {
const { container, render, unmount } = renderIntoContainer(
- <TabItem tab="WORKSHEET" onClick={() => {}} />
+ <TabItem tab="SAVED_QUERY" onClick={() => {}} />
);
render();
- expect(container.textContent).toContain("worksheet.self");
+ expect(container.textContent).toContain("saved-query.self");
expect(container.querySelector("button")).not.toBeNull();
unmount();
});
@@ -109,7 +109,7 @@ describe("TabItem", () => {
});
test("does NOT apply active class when asidePanelTab differs", () => {
- mocks.currentAsidePanelTab = "WORKSHEET";
+ mocks.currentAsidePanelTab = "SAVED_QUERY";
const { container, render, unmount } = renderIntoContainer(
<TabItem tab="SCHEMA" onClick={() => {}} />
);
diff --git a/frontend/src/modules/sql-editor/components/TabItem.tsx b/frontend/src/modules/sql-editor/components/TabItem.tsx
index 5303586742..8036e87a8e 100644
--- a/frontend/src/modules/sql-editor/components/TabItem.tsx
+++ b/frontend/src/modules/sql-editor/components/TabItem.tsx
@@ -12,7 +12,7 @@ type TabItemProps = {
};
const iconByTab = {
- WORKSHEET: FileCode,
+ SAVED_QUERY: FileCode,
SCHEMA: Database,
HISTORY: History,
ACCESS: ShieldCheck,
@@ -30,7 +30,7 @@ export function TabItem({ tab, onClick }: TabItemProps) {
const Icon = iconByTab[tab];
const labelByTab = {
- WORKSHEET: t("worksheet.self"),
+ SAVED_QUERY: t("saved-query.self"),
SCHEMA: t("common.schema"),
HISTORY: t("common.history"),
ACCESS: t("sql-editor.access-grants"),
diff --git a/frontend/src/modules/sql-editor/components/TabItem/Label.test.tsx b/frontend/src/modules/sql-editor/components/TabItem/Label.test.tsx
index a241f85b9d..a7222678cc 100644
--- a/frontend/src/modules/sql-editor/components/TabItem/Label.test.tsx
+++ b/frontend/src/modules/sql-editor/components/TabItem/Label.test.tsx
@@ -11,7 +11,7 @@ import type { SQLEditorTab } from "@/types/sqlEditor/tab";
const mocks = vi.hoisted(() => ({
updateTab: vi.fn(),
setCurrentTabId: vi.fn(),
- patchWorksheet: vi.fn().mockResolvedValue(undefined),
+ patchSavedQuery: vi.fn().mockResolvedValue(undefined),
getSQLEditorTabsState: vi.fn(),
tabListEvents: {
on: vi.fn<(event: string, h: (p: unknown) => void) => () => void>(),
@@ -20,7 +20,7 @@ const mocks = vi.hoisted(() => ({
vi.mock("@/stores/app", () => ({
useAppStore: {
- getState: () => ({ patchWorksheet: mocks.patchWorksheet }),
+ getState: () => ({ patchSavedQuery: mocks.patchSavedQuery }),
},
}));
@@ -40,13 +40,13 @@ vi.mock("@/components/ui/ellipsis-text", () => ({
),
}));
-// WorksheetSchema + @bufbuild/protobuf pull native deps; stub them.
+// SavedQuerySchema + @bufbuild/protobuf pull native deps; stub them.
vi.mock("@bufbuild/protobuf", () => ({
create: vi.fn((schema, data) => ({ ...data, $schema: schema })),
}));
-vi.mock("@/types/proto-es/v1/worksheet_service_pb", () => ({
- WorksheetSchema: { typeName: "WorksheetSchema" },
+vi.mock("@/types/proto-es/v1/saved_query_service_pb", () => ({
+ SavedQuerySchema: { typeName: "SavedQuerySchema" },
}));
let Label: typeof import("./Label").Label;
@@ -76,7 +76,7 @@ const makeTab = (overrides: Partial<SQLEditorTab> = {}): SQLEditorTab =>
id: "t1",
title: "My query",
status: "CLEAN",
- worksheet: "",
+ savedQuery: "",
viewState: { view: "CODE" },
...overrides,
}) as unknown as SQLEditorTab;
diff --git a/frontend/src/modules/sql-editor/components/TabItem/Label.tsx b/frontend/src/modules/sql-editor/components/TabItem/Label.tsx
index a8e27fdfdc..b09fc4f476 100644
--- a/frontend/src/modules/sql-editor/components/TabItem/Label.tsx
+++ b/frontend/src/modules/sql-editor/components/TabItem/Label.tsx
@@ -6,7 +6,7 @@ import { cn } from "@/lib/utils";
import { tabListEvents } from "@/modules/sql-editor/model/TabList/events";
import { getSQLEditorTabsState } from "@/modules/sql-editor/store/tab";
import { useAppStore } from "@/stores/app";
-import { WorksheetSchema } from "@/types/proto-es/v1/worksheet_service_pb";
+import { SavedQuerySchema } from "@/types/proto-es/v1/saved_query_service_pb";
import type { SQLEditorTab } from "@/types/sqlEditor/tab";
type Props = {
@@ -53,10 +53,10 @@ export function Label({ tab }: Props) {
const confirmEdit = () => {
const title = draft.trim();
getSQLEditorTabsState().updateTab(tab.id, { title });
- if (tab.worksheet) {
- void useAppStore.getState().patchWorksheet(
- create(WorksheetSchema, {
- name: tab.worksheet,
+ if (tab.savedQuery) {
+ void useAppStore.getState().patchSavedQuery(
+ create(SavedQuerySchema, {
+ name: tab.savedQuery,
title,
}),
["title"]
@@ -78,7 +78,7 @@ export function Label({ tab }: Props) {
}, [editing]);
// Keep draft in sync when the tab title updates from elsewhere (auto-save,
- // worksheet fetch) while not editing.
+ // saved query fetch) while not editing.
useEffect(() => {
if (!editing) {
setDraft(tab.title);
diff --git a/frontend/src/modules/sql-editor/components/TabItem/Prefix.tsx b/frontend/src/modules/sql-editor/components/TabItem/Prefix.tsx
index e99a32b20f..ca2dba1de7 100644
--- a/frontend/src/modules/sql-editor/components/TabItem/Prefix.tsx
+++ b/frontend/src/modules/sql-editor/components/TabItem/Prefix.tsx
@@ -11,18 +11,18 @@ type Props = {
/**
* Replaces frontend/src/views/sql-editor/TabList/TabItem/Prefix.vue.
* Leading icons on a tab row:
- * - Pencil for draft (no worksheet yet).
- * - Users glyph when viewing someone else's shared worksheet.
+ * - Pencil for draft (no saved query yet).
+ * - Users glyph when viewing someone else's shared savedQuery.
* - Wrench when the tab is in ADMIN mode.
* - Engine icon / unlink glyph via SheetConnectionIcon.
*/
export function Prefix({ tab }: Props) {
- const { isWorksheetCreator } = useSheetContext();
+ const { isSavedQueryCreator } = useSheetContext();
- const isDraft = !tab.worksheet && tab.viewState.view === "CODE";
+ const isDraft = !tab.savedQuery && tab.viewState.view === "CODE";
const sheet = useAppStore((s) =>
- tab.worksheet ? s.getWorksheetByName(tab.worksheet) : null
+ tab.savedQuery ? s.getSavedQueryByName(tab.savedQuery) : null
);
return (
@@ -31,7 +31,7 @@ export function Prefix({ tab }: Props) {
<PencilLine className="size-4" />
) : (
<>
- {sheet && !isWorksheetCreator(sheet) && <Users className="size-4" />}
+ {sheet && !isSavedQueryCreator(sheet) && <Users className="size-4" />}
{tab.mode === "ADMIN" && <Wrench className="size-4" />}
</>
)}
diff --git a/frontend/src/modules/sql-editor/components/TabItem/Suffix.test.tsx b/frontend/src/modules/sql-editor/components/TabItem/Suffix.test.tsx
index c545463dbc..1f50fd7321 100644
--- a/frontend/src/modules/sql-editor/components/TabItem/Suffix.test.tsx
+++ b/frontend/src/modules/sql-editor/components/TabItem/Suffix.test.tsx
@@ -33,7 +33,7 @@ const renderIntoContainer = (element: ReactElement) => {
const makeTab = (overrides: Partial<SQLEditorTab> = {}): SQLEditorTab =>
({
id: "t1",
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
status: "CLEAN",
...overrides,
}) as unknown as SQLEditorTab;
@@ -69,7 +69,7 @@ describe("Suffix", () => {
unmount();
});
- test("SAVING WORKSHEET tab renders the spinner (takes priority over hover)", () => {
+ test("SAVING SAVED_QUERY tab renders the spinner (takes priority over hover)", () => {
const { container, render, unmount } = renderIntoContainer(
<Suffix tab={makeTab({ status: "SAVING" })} onClose={vi.fn()} />
);
@@ -80,7 +80,7 @@ describe("Suffix", () => {
unmount();
});
- test("DIRTY WORKSHEET tab renders the unsaved-dot icon (when not hovered)", () => {
+ test("DIRTY SAVED_QUERY tab renders the unsaved-dot icon (when not hovered)", () => {
const { container, render, unmount } = renderIntoContainer(
<Suffix tab={makeTab({ status: "DIRTY" })} onClose={vi.fn()} />
);
diff --git a/frontend/src/modules/sql-editor/components/TabItem/Suffix.tsx b/frontend/src/modules/sql-editor/components/TabItem/Suffix.tsx
index 8048522e29..1f9a114d01 100644
--- a/frontend/src/modules/sql-editor/components/TabItem/Suffix.tsx
+++ b/frontend/src/modules/sql-editor/components/TabItem/Suffix.tsx
@@ -21,9 +21,9 @@ export function Suffix({ tab, onClose }: Props) {
const icon = ((): IconKind => {
// Always show saving indicator when saving, even while hovering.
- if (tab.mode === "WORKSHEET" && tab.status === "SAVING") return "saving";
+ if (tab.mode === "SAVED_QUERY" && tab.status === "SAVING") return "saving";
if (hovering) return "close";
- if (tab.mode === "WORKSHEET" && tab.status === "DIRTY") return "unsaved";
+ if (tab.mode === "SAVED_QUERY" && tab.status === "DIRTY") return "unsaved";
return "close";
})();
@@ -35,8 +35,8 @@ export function Suffix({ tab, onClose }: Props) {
);
const accent =
- (tab.mode === "WORKSHEET" && tab.status === "DIRTY") ||
- (tab.mode === "WORKSHEET" && tab.status === "SAVING")
+ (tab.mode === "SAVED_QUERY" && tab.status === "DIRTY") ||
+ (tab.mode === "SAVED_QUERY" && tab.status === "SAVING")
? "text-accent"
: "";
diff --git a/frontend/src/modules/sql-editor/components/TabItem/TabItem.tsx b/frontend/src/modules/sql-editor/components/TabItem/TabItem.tsx
index f8a447b07f..247732cb24 100644
--- a/frontend/src/modules/sql-editor/components/TabItem/TabItem.tsx
+++ b/frontend/src/modules/sql-editor/components/TabItem/TabItem.tsx
@@ -127,7 +127,7 @@ export function TabItem({
style={bodyStyle}
>
<Prefix tab={tab} />
- {tab.mode === "WORKSHEET" ? (
+ {tab.mode === "SAVED_QUERY" ? (
<Label tab={tab} />
) : (
<AdminLabel tab={tab} />
diff --git a/frontend/src/modules/sql-editor/components/TabList.test.tsx b/frontend/src/modules/sql-editor/components/TabList.test.tsx
index 61fc6c6cca..8f4e71257a 100644
--- a/frontend/src/modules/sql-editor/components/TabList.test.tsx
+++ b/frontend/src/modules/sql-editor/components/TabList.test.tsx
@@ -28,7 +28,7 @@ const mocks = vi.hoisted(() => ({
},
closeTab: vi.fn(),
setCurrentTabId: vi.fn(),
- createWorksheet: vi.fn().mockResolvedValue(undefined),
+ createSavedQuery: vi.fn().mockResolvedValue(undefined),
tabListEventsOn:
vi.fn<(event: string, h: (p: unknown) => void) => () => void>(),
}));
@@ -48,10 +48,10 @@ vi.mock("@/modules/sql-editor/store/tab", () => ({
vi.mock("@/modules/sql-editor/store", () => ({
useSQLEditorStore: (
- selector: (s: { createWorksheet: typeof mocks.createWorksheet }) => unknown
+ selector: (s: { createSavedQuery: typeof mocks.createSavedQuery }) => unknown
) =>
selector({
- createWorksheet: mocks.createWorksheet,
+ createSavedQuery: mocks.createSavedQuery,
}),
}));
@@ -209,7 +209,7 @@ const makeTab = (
({
id,
title: `t-${id}`,
- mode: "WORKSHEET",
+ mode: "SAVED_QUERY",
status: "CLEAN",
...overrides,
}) as unknown as SQLEditorTab;
@@ -269,7 +269,7 @@ describe("TabList", () => {
unmount();
});
- test("closing a DIRTY worksheet opens the confirm dialog", () => {
+ test("closing a DIRTY saved query opens the confirm dialog", () => {
setup([makeTab("a", { status: "DIRTY" })]);
const { container, render, unmount } = renderIntoContainer(<TabList />);
render();
@@ -284,7 +284,7 @@ describe("TabList", () => {
unmount();
});
- test("+ button calls worksheetStore.createWorksheet", () => {
+ test("+ button calls savedQueryStore.createSavedQuery", () => {
setup([makeTab("a")]);
const { container, render, unmount } = renderIntoContainer(<TabList />);
render();
@@ -295,7 +295,7 @@ describe("TabList", () => {
act(() => {
addButton?.click();
});
- expect(mocks.createWorksheet).toHaveBeenCalled();
+ expect(mocks.createSavedQuery).toHaveBeenCalled();
unmount();
});
diff --git a/frontend/src/modules/sql-editor/components/TabList.tsx b/frontend/src/modules/sql-editor/components/TabList.tsx
index 714d31234a..e233ba017d 100644
--- a/frontend/src/modules/sql-editor/components/TabList.tsx
+++ b/frontend/src/modules/sql-editor/components/TabList.tsx
@@ -55,12 +55,12 @@ type PendingClose = {
/**
* Replaces frontend/src/views/sql-editor/TabList/TabList.vue.
* Horizontal tab bar at the top of the SQL editor. Drag-reorder via
- * @dnd-kit, overflow-x scroll, "+" button to add a new worksheet, and
+ * @dnd-kit, overflow-x scroll, "+" button to add a new saved query, and
* right-click context menu delegated to TabContextMenu.
*/
export function TabList() {
const { t } = useTranslation();
- const createWorksheet = useSQLEditorStore((s) => s.createWorksheet);
+ const createSavedQuery = useSQLEditorStore((s) => s.createSavedQuery);
// Zustand's selector subscribes to in-place tab mutations because
// `updateTab` reassigns / triggers an immer produce on `tabsById`,
@@ -142,7 +142,7 @@ export function TabList() {
const removeTab = useCallback(
async (tab: SQLEditorTab, focusWhenConfirm = false) => {
const tabsState = getSQLEditorTabsState();
- if (tab.mode === "WORKSHEET" && tab.status !== "CLEAN") {
+ if (tab.mode === "SAVED_QUERY" && tab.status !== "CLEAN") {
if (focusWhenConfirm) {
tabsState.setCurrentTabId(tab.id);
}
@@ -160,7 +160,7 @@ export function TabList() {
if (loading) return;
setLoading(true);
try {
- await createWorksheet({});
+ await createSavedQuery({});
requestAnimationFrame(() => {
const el = scrollRef.current;
if (el) el.scrollTo(el.scrollWidth, 0);
@@ -205,7 +205,7 @@ export function TabList() {
getSQLEditorTabsState().setOpenTabListOrder(
next.map((tab) => ({
id: tab.id,
- worksheet: tab.worksheet,
+ savedQuery: tab.savedQuery,
mode: tab.mode,
batchQueryContext: tab.batchQueryContext,
treeState: tab.treeState,
@@ -321,7 +321,7 @@ export function TabList() {
<AlertDialog
open={pendingClose !== null}
// Vue's confirm dialog used `closeOnEsc: false`, `maskClosable: false`,
- // `closable: false` — the user MUST click Cancel or "Close sheet".
+ // `closable: false` — the user MUST click Cancel or "Close tab".
// Cancel Base UI's close when the reason is Esc / outside-click so
// the dialog stays open and forces an explicit choice.
onOpenChange={(
diff --git a/frontend/src/modules/sql-editor/components/TreeNodePrefix.test.tsx b/frontend/src/modules/sql-editor/components/TreeNodePrefix.test.tsx
index 5d6d9c57ac..c04156ee18 100644
--- a/frontend/src/modules/sql-editor/components/TreeNodePrefix.test.tsx
+++ b/frontend/src/modules/sql-editor/components/TreeNodePrefix.test.tsx
@@ -1,7 +1,7 @@
import { act } from "react";
import { createRoot } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, test } from "vitest";
-import type { WorksheetFolderNode } from "@/modules/sql-editor/model/Sheet";
+import type { SavedQueryFolderNode } from "@/modules/sql-editor/model/Sheet";
(
globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
@@ -15,8 +15,8 @@ globalThis.ResizeObserver = class ResizeObserver {
};
const makeNode = (
- overrides?: Partial<WorksheetFolderNode>
-): WorksheetFolderNode => ({
+ overrides?: Partial<SavedQueryFolderNode>
+): SavedQueryFolderNode => ({
key: "/my/folder",
label: "folder",
editable: true,
@@ -56,13 +56,13 @@ afterEach(() => {
});
describe("TreeNodePrefix", () => {
- test("renders FileCode icon when node has a worksheet property", () => {
+ test("renders FileCode icon when node has a saved query property", () => {
const node = makeNode({
- worksheet: {
- name: "worksheets/ws1",
+ savedQuery: {
+ name: "savedQueries/ws1",
title: "My Query",
folders: [],
- type: "worksheet",
+ type: "savedQuery",
},
});
const { container, render, unmount } = renderIntoContainer(
diff --git a/frontend/src/modules/sql-editor/components/TreeNodePrefix.tsx b/frontend/src/modules/sql-editor/components/TreeNodePrefix.tsx
index c7cb09c61f..87d37738a3 100644
--- a/frontend/src/modules/sql-editor/components/TreeNodePrefix.tsx
+++ b/frontend/src/modules/sql-editor/components/TreeNodePrefix.tsx
@@ -5,11 +5,11 @@ import {
FolderPen,
FolderSync,
} from "lucide-react";
-import type { WorksheetFolderNode } from "@/modules/sql-editor/model/Sheet";
+import type { SavedQueryFolderNode } from "@/modules/sql-editor/model/Sheet";
import type { SheetViewMode } from "@/modules/sql-editor/model/Sheet/types";
type Props = {
- readonly node: WorksheetFolderNode;
+ readonly node: SavedQueryFolderNode;
readonly isOpen: boolean;
readonly rootPath: string;
readonly view: SheetViewMode;
@@ -18,7 +18,7 @@ type Props = {
export function TreeNodePrefix({ node, isOpen, rootPath, view }: Props) {
const cls = "size-4 text-control shrink-0";
- if (node.worksheet) {
+ if (node.savedQuery) {
return <FileCode className={cls} />;
}
if (isOpen) {
diff --git a/frontend/src/modules/sql-editor/components/TreeNodeSuffix.test.tsx b/frontend/src/modules/sql-editor/components/TreeNodeSuffix.test.tsx
index 9ee6bc141c..c6b104b5a0 100644
--- a/frontend/src/modules/sql-editor/components/TreeNodeSuffix.test.tsx
+++ b/frontend/src/modules/sql-editor/components/TreeNodeSuffix.test.tsx
@@ -1,7 +1,7 @@
import { act } from "react";
import { createRoot } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
-import type { WorksheetFolderNode } from "@/modules/sql-editor/model/Sheet";
+import type { SavedQueryFolderNode } from "@/modules/sql-editor/model/Sheet";
(
globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }
@@ -19,7 +19,7 @@ globalThis.ResizeObserver = class ResizeObserver {
const mocks = vi.hoisted(() => ({
useTranslation: vi.fn(() => ({ t: (key: string) => key })),
getSQLEditorTabsState: vi.fn(),
- getWorksheetByName: vi.fn<(name: string) => unknown>(),
+ getSavedQueryByName: vi.fn<(name: string) => unknown>(),
getUserByIdentifier: vi.fn<() => { title: string } | undefined>(() => ({
title: "Test User",
})),
@@ -33,7 +33,7 @@ vi.mock("react-i18next", () => ({
vi.mock("@/stores/app", () => {
const state = {
- getWorksheetByName: mocks.getWorksheetByName,
+ getSavedQueryByName: mocks.getSavedQueryByName,
getUserByIdentifier: mocks.getUserByIdentifier,
getOrFetchUserByIdentifier: mocks.getOrFetchUserByIdentifier,
};
@@ -68,8 +68,8 @@ vi.mock("@/components/ui/tooltip", () => ({
),
}));
-vi.mock("@/types/proto-es/v1/worksheet_service_pb", () => ({
- Worksheet_Visibility: {
+vi.mock("@/types/proto-es/v1/saved_query_service_pb", () => ({
+ SavedQuery_Visibility: {
PRIVATE: 0,
PROJECT_READ: 1,
PROJECT_WRITE: 2,
@@ -79,8 +79,8 @@ vi.mock("@/types/proto-es/v1/worksheet_service_pb", () => ({
// ---- helpers ----------------------------------------------------------------
const makeNode = (
- overrides?: Partial<WorksheetFolderNode>
-): WorksheetFolderNode => ({
+ overrides?: Partial<SavedQueryFolderNode>
+): SavedQueryFolderNode => ({
key: "/my/folder",
label: "folder",
editable: true,
@@ -89,17 +89,17 @@ const makeNode = (
...overrides,
});
-const makeWorksheetNode = (
- overrides?: Partial<WorksheetFolderNode>
-): WorksheetFolderNode =>
+const makeSavedQueryNode = (
+ overrides?: Partial<SavedQueryFolderNode>
+): SavedQueryFolderNode =>
makeNode({
key: "/my/folder/ws1",
label: "My Query",
- worksheet: {
- name: "worksheets/ws1",
+ savedQuery: {
+ name: "savedQueries/ws1",
title: "My Query",
folders: [],
- type: "worksheet",
+ type: "savedQuery",
},
...overrides,
});
@@ -127,7 +127,7 @@ const renderIntoContainer = (element: React.ReactElement) => {
let TreeNodeSuffix: typeof import("./TreeNodeSuffix").TreeNodeSuffix;
beforeEach(async () => {
- mocks.getWorksheetByName.mockImplementation((name: string) => ({
+ mocks.getSavedQueryByName.mockImplementation((name: string) => ({
name,
starred: false,
visibility: 0, // PRIVATE
@@ -140,7 +140,7 @@ beforeEach(async () => {
mocks.getUserByIdentifier.mockReturnValue({ title: "Test User" });
mocks.getOrFetchUserByIdentifier.mockResolvedValue({ title: "Test User" });
mocks.useSheetContext.mockReturnValue({
- isWorksheetCreator: vi.fn(() => true),
+ isSavedQueryCreator: vi.fn(() => true),
});
({ TreeNodeSuffix } = await import("./TreeNodeSuffix"));
@@ -152,8 +152,8 @@ afterEach(() => {
});
describe("TreeNodeSuffix", () => {
- test("renders star icon for worksheet node; click fires onToggleStar with correct args", () => {
- const node = makeWorksheetNode();
+ test("renders star icon for saved query node; click fires onToggleStar with correct args", () => {
+ const node = makeSavedQueryNode();
const onToggleStar = vi.fn();
const onSharePanelShow = vi.fn();
const onContextMenuShow = vi.fn();
@@ -179,7 +179,7 @@ describe("TreeNodeSuffix", () => {
});
expect(onToggleStar).toHaveBeenCalledWith({
- worksheet: "worksheets/ws1",
+ savedQuery: "savedQueries/ws1",
starred: true, // was false, toggled to true
});
@@ -187,7 +187,7 @@ describe("TreeNodeSuffix", () => {
});
test("does not render star icon for folder nodes", () => {
- const node = makeNode(); // folder, no worksheet
+ const node = makeNode(); // folder, no savedQuery
const onToggleStar = vi.fn();
const onSharePanelShow = vi.fn();
const onContextMenuShow = vi.fn();
@@ -209,9 +209,9 @@ describe("TreeNodeSuffix", () => {
unmount();
});
- test("fetches worksheet creator before rendering the raw identifier", () => {
+ test("fetches saved query creator before rendering the raw identifier", () => {
mocks.getUserByIdentifier.mockReturnValue(undefined);
- const node = makeWorksheetNode();
+ const node = makeSavedQueryNode();
const onToggleStar = vi.fn();
const onSharePanelShow = vi.fn();
const onContextMenuShow = vi.fn();
@@ -235,7 +235,7 @@ describe("TreeNodeSuffix", () => {
});
test('"More" button fires onContextMenuShow with the node', () => {
- const node = makeWorksheetNode();
+ const node = makeSavedQueryNode();
const onContextMenuShow = vi.fn();
const onToggleStar = vi.fn();
const onSharePanelShow = vi.fn();
diff --git a/frontend/src/modules/sql-editor/components/TreeNodeSuffix.tsx b/frontend/src/modules/sql-editor/components/TreeNodeSuffix.tsx
index a77b1be572..d8f931f018 100644
--- a/frontend/src/modules/sql-editor/components/TreeNodeSuffix.tsx
+++ b/frontend/src/modules/sql-editor/components/TreeNodeSuffix.tsx
@@ -5,27 +5,27 @@ import { useShallow } from "zustand/react/shallow";
import { Tooltip } from "@/components/ui/tooltip";
import { cn } from "@/lib/utils";
import {
+ type SavedQueryFolderNode,
type SheetViewMode,
useSheetContext,
- type WorksheetFolderNode,
} from "@/modules/sql-editor/model/Sheet";
import { getSQLEditorTabsState } from "@/modules/sql-editor/store/tab";
import { useAppStore } from "@/stores/app";
-import { Worksheet_Visibility } from "@/types/proto-es/v1/worksheet_service_pb";
+import { SavedQuery_Visibility } from "@/types/proto-es/v1/saved_query_service_pb";
type Props = {
- readonly node: WorksheetFolderNode;
+ readonly node: SavedQueryFolderNode;
readonly view: SheetViewMode;
readonly onSharePanelShow: (
e: React.MouseEvent,
- node: WorksheetFolderNode
+ node: SavedQueryFolderNode
) => void;
readonly onContextMenuShow: (
e: React.MouseEvent,
- node: WorksheetFolderNode
+ node: SavedQueryFolderNode
) => void;
readonly onToggleStar: (args: {
- worksheet: string;
+ savedQuery: string;
starred: boolean;
}) => void;
};
@@ -39,18 +39,18 @@ export function TreeNodeSuffix({
}: Props) {
const { t } = useTranslation();
- const { isWorksheetCreator } = useSheetContext();
+ const { isSavedQueryCreator } = useSheetContext();
// `useShallow` is required: this selector builds a fresh object each
// call, which would fail `useSyncExternalStore`'s `Object.is` snapshot
// check and spin an infinite render loop. Shallow-comparing the fields
- // keeps the snapshot stable when the worksheet's values are unchanged.
- const worksheetLite = useAppStore(
+ // keeps the snapshot stable when the saved query's values are unchanged.
+ const savedQueryLite = useAppStore(
useShallow((state) => {
- if (!node.worksheet) {
+ if (!node.savedQuery) {
return undefined;
}
- const sheet = state.getWorksheetByName(node.worksheet.name);
+ const sheet = state.getSavedQueryByName(node.savedQuery.name);
if (!sheet) {
return undefined;
}
@@ -62,9 +62,9 @@ export function TreeNodeSuffix({
};
})
);
- const worksheetCreatorTitle = useAppStore((state) =>
- worksheetLite?.creator
- ? state.getUserByIdentifier(worksheetLite.creator)?.title
+ const savedQueryCreatorTitle = useAppStore((state) =>
+ savedQueryLite?.creator
+ ? state.getUserByIdentifier(savedQueryLite.creator)?.title
: undefined
);
const getOrFetchUserByIdentifier = useAppStore(
@@ -72,23 +72,23 @@ export function TreeNodeSuffix({
);
useEffect(() => {
- if (!worksheetLite?.creator || worksheetCreatorTitle) {
+ if (!savedQueryLite?.creator || savedQueryCreatorTitle) {
return;
}
- void getOrFetchUserByIdentifier({ identifier: worksheetLite.creator });
+ void getOrFetchUserByIdentifier({ identifier: savedQueryLite.creator });
}, [
getOrFetchUserByIdentifier,
- worksheetCreatorTitle,
- worksheetLite?.creator,
+ savedQueryCreatorTitle,
+ savedQueryLite?.creator,
]);
- const visibilityDisplayName = (visibility: Worksheet_Visibility) => {
+ const visibilityDisplayName = (visibility: SavedQuery_Visibility) => {
switch (visibility) {
- case Worksheet_Visibility.PRIVATE:
+ case SavedQuery_Visibility.PRIVATE:
return t("sql-editor.private");
- case Worksheet_Visibility.PROJECT_READ:
+ case SavedQuery_Visibility.PROJECT_READ:
return t("sql-editor.project-read");
- case Worksheet_Visibility.PROJECT_WRITE:
+ case SavedQuery_Visibility.PROJECT_WRITE:
return t("sql-editor.project-write");
default:
return "";
@@ -96,12 +96,12 @@ export function TreeNodeSuffix({
};
const creatorForSheet = (creator: string) => {
- return worksheetCreatorTitle ?? creator;
+ return savedQueryCreatorTitle ?? creator;
};
// Draft view: show X button to close the draft tab
if (view === "draft") {
- if (!node.worksheet) {
+ if (!node.savedQuery) {
return null;
}
return (
@@ -109,10 +109,10 @@ export function TreeNodeSuffix({
className="size-4 text-control shrink-0"
onClick={(e) => {
e.stopPropagation();
- if (!node.worksheet?.name) return;
- // Draft nodes use tab.id as worksheet.name (drafts have no worksheet field).
+ if (!node.savedQuery?.name) return;
+ // Draft nodes use tab.id as savedQuery.name (drafts have no saved query field).
const tabsState = getSQLEditorTabsState();
- const tab = tabsState.tabsById.get(node.worksheet.name);
+ const tab = tabsState.tabsById.get(node.savedQuery.name);
if (tab && tab.status !== "CLEAN") {
if (
!window.confirm(
@@ -122,14 +122,14 @@ export function TreeNodeSuffix({
return;
}
}
- tabsState.closeTab(node.worksheet.name);
+ tabsState.closeTab(node.savedQuery.name);
}}
/>
);
}
// Folder node: only show "More" button
- if (!node.worksheet) {
+ if (!node.savedQuery) {
return (
<MoreHorizontal
className="size-4 text-control shrink-0 cursor-pointer"
@@ -142,14 +142,14 @@ export function TreeNodeSuffix({
);
}
- // Worksheet node: visibility badge + star + more
- if (!worksheetLite) {
+ // SavedQuery node: visibility badge + star + more
+ if (!savedQueryLite) {
return null;
}
const showVisibilityBadge =
- worksheetLite.visibility === Worksheet_Visibility.PROJECT_READ ||
- worksheetLite.visibility === Worksheet_Visibility.PROJECT_WRITE;
+ savedQueryLite.visibility === SavedQuery_Visibility.PROJECT_READ ||
+ savedQueryLite.visibility === SavedQuery_Visibility.PROJECT_WRITE;
return (
<div className="inline-flex shrink-0 items-center gap-x-1">
@@ -160,13 +160,13 @@ export function TreeNodeSuffix({
<div>
{t("common.visibility")}
{": "}
- {visibilityDisplayName(worksheetLite.visibility)}
+ {visibilityDisplayName(savedQueryLite.visibility)}
</div>
- {!isWorksheetCreator(worksheetLite) && (
+ {!isSavedQueryCreator(savedQueryLite) && (
<div>
{t("common.creator")}
{": "}
- {creatorForSheet(worksheetLite.creator)}
+ {creatorForSheet(savedQueryLite.creator)}
</div>
)}
</div>
@@ -184,13 +184,13 @@ export function TreeNodeSuffix({
<Star
className={cn(
"size-4 shrink-0",
- worksheetLite.starred ? "text-yellow-400" : "text-control-light"
+ savedQueryLite.starred ? "text-yellow-400" : "text-control-light"
)}
onClick={(e) => {
e.stopPropagation();
onToggleStar({
- worksheet: worksheetLite.name,
- starred: !worksheetLite.starred,
+ savedQuery: savedQueryLite.name,
+ starred: !savedQueryLite.starred,
});
}}
/>
diff --git a/frontend/src/modules/sql-editor/components/filterNode.test.ts b/frontend/src/modules/sql-editor/components/filterNode.test.ts
index 1249a49f5b..88bd74ebaa 100644
--- a/frontend/src/modules/sql-editor/components/filterNode.test.ts
+++ b/frontend/src/modules/sql-editor/components/filterNode.test.ts
@@ -1,12 +1,12 @@
import { describe, expect, test } from "vitest";
-import type { WorksheetFolderNode } from "@/modules/sql-editor/model/Sheet";
+import type { SavedQueryFolderNode } from "@/modules/sql-editor/model/Sheet";
import { filterNode } from "./filterNode";
const makeNode = (
- partial: Partial<WorksheetFolderNode>
-): WorksheetFolderNode => ({
+ partial: Partial<SavedQueryFolderNode>
+): SavedQueryFolderNode => ({
...partial,
key: "/my/node",
label: "node",
@@ -22,7 +22,7 @@ describe("filterNode", () => {
pred(
"payroll",
makeNode({
- key: "__worksheet_load_more__:/my",
+ key: "__savedQuery_load_more__:/my",
label: "common.load-more",
loadMore: true,
})
diff --git a/frontend/src/modules/sql-editor/components/filterNode.ts b/frontend/src/modules/sql-editor/components/filterNode.ts
index 75dc336e7b..36f6ade376 100644
--- a/frontend/src/modules/sql-editor/components/filterNode.ts
+++ b/frontend/src/modules/sql-editor/components/filterNode.ts
@@ -1,14 +1,14 @@
-import type { WorksheetFolderNode } from "@/modules/sql-editor/model/Sheet";
+import type { SavedQueryFolderNode } from "@/modules/sql-editor/model/Sheet";
/**
- * Returns a filter predicate for the worksheet tree.
+ * Returns a filter predicate for the saved query tree.
*
* The predicate always shows the root node (matched by `rootPath`), load-more
* rows, and any node whose label contains the search keyword (case-insensitive).
*/
export const filterNode =
(rootPath: string) =>
- (pattern: string, option: WorksheetFolderNode): boolean => {
+ (pattern: string, option: SavedQueryFolderNode): boolean => {
const keyword = pattern.trim().toLowerCase();
if (option.key === rootPath || option.loadMore || !keyword) {
return true;
diff --git a/frontend/src/modules/sql-editor/components/theme/useActiveSQLEditorTheme.ts b/frontend/src/modules/sql-editor/components/theme/useActiveSQLEditorTheme.ts
index 8c3b3704f3..f9b5e150c3 100644
--- a/frontend/src/modules/sql-editor/components/theme/useActiveSQLEditorTheme.ts
+++ b/frontend/src/modules/sql-editor/components/theme/useActiveSQLEditorTheme.ts
@@ -5,7 +5,7 @@ import { useWorkspaceSQLEditorTheme } from "./useWorkspaceSQLEditorTheme";
/**
* The SQL Editor theme that should currently apply to the foreground code
- * surface: the selected theme in worksheet mode, or its admin resolution
+ * surface: the selected theme in saved query mode, or its admin resolution
* (selected-if-dark-else-dark) in admin mode. Used both for the chrome's
* Monaco theme name and to drive the global Monaco theme controller.
*/
diff --git a/frontend/src/modules/sql-editor/components/theme/useMonacoThemeController.test.tsx b/frontend/src/modules/sql-editor/components/theme/useMonacoThemeController.test.tsx
index 72fc75eb0f..66ccf4b2f4 100644
--- a/frontend/src/modules/sql-editor/components/theme/useMonacoThemeController.test.tsx
+++ b/frontend/src/modules/sql-editor/components/theme/useMonacoThemeController.test.tsx
@@ -6,7 +6,7 @@ import type { SQLEditorTheme } from "./types";
import { useMonacoThemeController } from "./useMonacoThemeController";
const mocks = vi.hoisted(() => ({
- mode: "WORKSHEET" as SQLEditorTabMode,
+ mode: "SAVED_QUERY" as SQLEditorTabMode,
setTheme: vi.fn(),
workspaceTheme: undefined as SQLEditorTheme | undefined,
}));
@@ -45,7 +45,7 @@ const flushEffects = async () => {
describe("useMonacoThemeController", () => {
beforeEach(() => {
- mocks.mode = "WORKSHEET";
+ mocks.mode = "SAVED_QUERY";
mocks.workspaceTheme = PRESET_BY_ID.light;
mocks.setTheme.mockClear();
});
diff --git a/frontend/src/modules/sql-editor/components/theme/useMonacoThemeController.ts b/frontend/src/modules/sql-editor/components/theme/useMonacoThemeController.ts
index 9e16ecaaa2..0c5a5aad2f 100644
--- a/frontend/src/modules/sql-editor/components/theme/useMonacoThemeController.ts
+++ b/frontend/src/modules/sql-editor/components/theme/useMonacoThemeController.ts
@@ -14,7 +14,7 @@ import { useWorkspaceSQLEditorTheme } from "./useWorkspaceSQLEditorTheme";
* its `options.theme`; calling the global `setTheme` *while an editor is still
* constructing* races the codingame VSCode theme service and throws, which makes
* the editor fall back to its read-only `<pre>`. So we only re-apply on a GENUINE
- * workspace-theme change (prev exists and differs). Mode-only flips (worksheet
+ * workspace-theme change (prev exists and differs). Mode-only flips (saved query
* ⇄ admin) remount their editor surface with the right construction theme, and
* calling global `setTheme` during that swap would race the new editor.
* This also makes the effect safe under React StrictMode's double-invoke — the
diff --git a/frontend/src/modules/sql-editor/components/useDropdown.test.ts b/frontend/src/modules/sql-editor/components/useDropdown.test.ts
index 205dad17fc..2208b4a960 100644
--- a/frontend/src/modules/sql-editor/components/useDropdown.test.ts
+++ b/frontend/src/modules/sql-editor/components/useDropdown.test.ts
@@ -1,16 +1,16 @@
import { act, renderHook } from "@testing-library/react";
import { afterEach, describe, expect, test, vi } from "vitest";
import type {
- WorksheetFilter,
- WorksheetFolderNode,
+ SavedQueryFilter,
+ SavedQueryFolderNode,
} from "@/modules/sql-editor/model/Sheet";
-import type { Worksheet } from "@/types/proto-es/v1/worksheet_service_pb";
+import type { SavedQuery } from "@/types/proto-es/v1/saved_query_service_pb";
import { useDropdown } from "./useDropdown";
const mocks = vi.hoisted(() => ({
currentUser: { email: "[email protected]" },
- worksheet: undefined as Worksheet | undefined,
- isWorksheetWritableV1: vi.fn(() => true),
+ savedQuery: undefined as SavedQuery | undefined,
+ isSavedQueryWritableV1: vi.fn(() => true),
}));
vi.mock("react-i18next", () => ({
@@ -24,15 +24,15 @@ vi.mock("@/hooks/useAppState", () => ({
vi.mock("@/stores/app", () => ({
useAppStore: (selector: (state: unknown) => unknown) =>
selector({
- getWorksheetByName: () => mocks.worksheet,
+ getSavedQueryByName: () => mocks.savedQuery,
}),
}));
vi.mock("@/utils", () => ({
- isWorksheetWritableV1: mocks.isWorksheetWritableV1,
+ isSavedQueryWritableV1: mocks.isSavedQueryWritableV1,
}));
-const baseFilter: WorksheetFilter = {
+const baseFilter: SavedQueryFilter = {
keyword: "",
onlyShowStarred: false,
showMine: true,
@@ -40,16 +40,16 @@ const baseFilter: WorksheetFilter = {
showDraft: true,
};
-const worksheetNode: WorksheetFolderNode = {
+const savedQueryNode: SavedQueryFolderNode = {
key: "/my/sheet",
label: "sheet",
editable: true,
children: [],
- worksheet: {
- name: "projects/proj/worksheets/sheet",
+ savedQuery: {
+ name: "projects/proj/savedQueries/sheet",
title: "sheet",
folders: [],
- type: "worksheet",
+ type: "savedQuery",
},
};
@@ -61,21 +61,21 @@ const event = {
describe("useDropdown", () => {
afterEach(() => {
vi.clearAllMocks();
- mocks.worksheet = undefined;
+ mocks.savedQuery = undefined;
});
- test("hides delete for writable shared worksheets", () => {
- mocks.worksheet = {
- name: "projects/proj/worksheets/sheet",
+ test("hides delete for writable shared saved queries", () => {
+ mocks.savedQuery = {
+ name: "projects/proj/savedQueries/sheet",
creator: "users/[email protected]",
- } as Worksheet;
+ } as SavedQuery;
const { result } = renderHook(() =>
useDropdown("shared", baseFilter, false)
);
act(() => {
- result.current.handleContextMenu(event, worksheetNode);
+ result.current.handleContextMenu(event, savedQueryNode);
});
expect(
@@ -83,16 +83,16 @@ describe("useDropdown", () => {
).toEqual(["duplicate", "rename"]);
});
- test("keeps delete for writable my worksheets", () => {
- mocks.worksheet = {
- name: "projects/proj/worksheets/sheet",
+ test("keeps delete for writable my saved queries", () => {
+ mocks.savedQuery = {
+ name: "projects/proj/savedQueries/sheet",
creator: "users/[email protected]",
- } as Worksheet;
+ } as SavedQuery;
const { result } = renderHook(() => useDropdown("my", baseFilter, false));
act(() => {
- result.current.handleContextMenu(event, worksheetNode);
+ result.current.handleContextMenu(event, savedQueryNode);
});
expect(
diff --git a/frontend/src/modules/sql-editor/components/useDropdown.ts b/frontend/src/modules/sql-editor/components/useDropdown.ts
index 36734c6afc..a6aeda2891 100644
--- a/frontend/src/modules/sql-editor/components/useDropdown.ts
+++ b/frontend/src/modules/sql-editor/components/useDropdown.ts
@@ -1,5 +1,5 @@
/**
- * useDropdown — context-menu state for the worksheet tree.
+ * useDropdown — context-menu state for the saved query tree.
*
* The hook exposes `confirmDelete` state that the consumer (SheetTree) binds
* to a shadcn AlertDialog, and `showSharePanel` + `handleSharePanelShow` so
@@ -11,12 +11,12 @@ import { useMemo, useState } from "react";
import { useTranslation } from "react-i18next";
import { useCurrentUser } from "@/hooks/useAppState";
import type {
+ SavedQueryFilter,
+ SavedQueryFolderNode,
SheetViewMode,
- WorksheetFilter,
- WorksheetFolderNode,
} from "@/modules/sql-editor/model/Sheet";
import { useAppStore } from "@/stores/app";
-import { isWorksheetWritableV1 } from "@/utils";
+import { isSavedQueryWritableV1 } from "@/utils";
// ---------------------------------------------------------------------------
// Types
@@ -27,7 +27,7 @@ export type DropdownOptionType =
| "rename"
| "delete"
| "add-folder"
- | "add-worksheet"
+ | "add-saved-query"
| "multi-select"
| "duplicate";
@@ -42,10 +42,10 @@ export type MenuItem =
export function useDropdown(
viewMode: SheetViewMode,
- worksheetFilter: WorksheetFilter,
+ savedQueryFilter: SavedQueryFilter,
// Only the "my" tree is wired to the parent's multi-select state. For
// other views (shared / draft) the context-menu entry is hidden so a
- // right-click on a shared worksheet cannot populate the my tree's
+ // right-click on a shared saved query cannot populate the my tree's
// checkedNodes — which the toolbar's Delete + Move-to-folder flows act on.
canMultiSelect = false
) {
@@ -57,24 +57,24 @@ export function useDropdown(
// Context state — current right-click target
// ------------------------------------------------------------------
const [currentNode, setCurrentNode] = useState<
- WorksheetFolderNode | undefined
+ SavedQueryFolderNode | undefined
>(undefined);
const [showSharePanel, setShowSharePanel] = useState(false);
// ------------------------------------------------------------------
// Reactive reads from Pinia / Vue stores
// ------------------------------------------------------------------
- const worksheetEntity = useAppStore((s) =>
- viewMode === "draft" || !currentNode?.worksheet
+ const savedQueryEntity = useAppStore((s) =>
+ viewMode === "draft" || !currentNode?.savedQuery
? undefined
- : s.getWorksheetByName(currentNode.worksheet.name)
+ : s.getSavedQueryByName(currentNode.savedQuery.name)
);
// ------------------------------------------------------------------
// Derived: allowed-to-create-new
// ------------------------------------------------------------------
const allowCreateNew =
- !worksheetFilter.keyword && !worksheetFilter.onlyShowStarred;
+ !savedQueryFilter.keyword && !savedQueryFilter.onlyShowStarred;
// ------------------------------------------------------------------
// Menu options — computed from current state
@@ -91,11 +91,11 @@ export function useDropdown(
const items: ItemDef[] = [];
- if (currentNode.worksheet) {
- if (!worksheetEntity) {
+ if (currentNode.savedQuery) {
+ if (!savedQueryEntity) {
return [];
}
- const isCreator = worksheetEntity.creator === `users/${me?.email ?? ""}`;
+ const isCreator = savedQueryEntity.creator === `users/${me?.email ?? ""}`;
items.push({
key: "duplicate",
label: isCreator ? t("common.duplicate") : t("common.fork"),
@@ -106,7 +106,7 @@ export function useDropdown(
label: t("common.share"),
});
}
- const canWriteSheet = isWorksheetWritableV1(worksheetEntity);
+ const canWriteSheet = isSavedQueryWritableV1(savedQueryEntity);
if (canWriteSheet) {
items.push({
key: "rename",
@@ -135,8 +135,8 @@ export function useDropdown(
if (viewMode === "my") {
if (allowCreateNew) {
items.push({
- key: "add-worksheet",
- label: t("sql-editor.tab.context-menu.actions.add-worksheet"),
+ key: "add-saved-query",
+ label: t("sql-editor.tab.context-menu.actions.add-saved-query"),
});
}
if (canMultiSelect) {
@@ -166,7 +166,7 @@ export function useDropdown(
}, [
viewMode,
currentNode,
- worksheetEntity,
+ savedQueryEntity,
me,
allowCreateNew,
canMultiSelect,
@@ -184,7 +184,7 @@ export function useDropdown(
*/
const handleContextMenu = (
e: React.MouseEvent,
- node: WorksheetFolderNode
+ node: SavedQueryFolderNode
) => {
e.preventDefault();
e.stopPropagation();
@@ -198,7 +198,7 @@ export function useDropdown(
*/
const handleSharePanelShow = (
e: React.MouseEvent,
- node: WorksheetFolderNode
+ node: SavedQueryFolderNode
) => {
e.preventDefault();
e.stopPropagation();
@@ -221,8 +221,8 @@ export function useDropdown(
currentNode,
/** Computed menu options for the ContextMenu. */
options,
- /** Worksheet entity resolved from the store (for SharePopoverBody). */
- worksheetEntity,
+ /** SavedQuery entity resolved from the store (for SharePopoverBody). */
+ savedQueryEntity,
/** Whether the share panel should be shown. */
showSharePanel,
/** Call from each row's onContextMenu to open the context menu. */
diff --git a/frontend/src/modules/sql-editor/components/useSQLEditorAutoSave.ts b/frontend/src/modules/sql-editor/components/useSQLEditorAutoSave.ts
index 1f10a3208d..0ec8872709 100644
--- a/frontend/src/modules/sql-editor/components/useSQLEditorAutoSave.ts
+++ b/frontend/src/modules/sql-editor/components/useSQLEditorAutoSave.ts
@@ -5,7 +5,7 @@ import {
useSQLEditorTabState,
} from "@/modules/sql-editor/store/tab";
import { useAppStore } from "@/stores/app";
-import { isWorksheetWritableV1 } from "@/utils";
+import { isSavedQueryWritableV1 } from "@/utils";
const AUTO_SAVE_DEBOUNCE_MS = 2000;
@@ -14,7 +14,7 @@ const AUTO_SAVE_DEBOUNCE_MS = 2000;
* `views/sql-editor/context.ts`'s `provideSQLEditorContext()`.
*
* Watches the active tab's `statement` and after a 2s debounce calls
- * `maybeUpdateWorksheet` if the tab is dirty + writable. Mirrors the
+ * `maybeUpdateSavedQuery` if the tab is dirty + writable. Mirrors the
* Vue `watchDebounced` behavior: aborts any in-flight auto-save when a
* newer one starts, reverts the tab to DIRTY on error (unless aborted),
* and re-flags DIRTY when the statement keeps changing during the save.
@@ -27,7 +27,9 @@ export function useSQLEditorAutoSave() {
const setAutoSaveController = useSQLEditorStore(
(s) => s.setAutoSaveController
);
- const maybeUpdateWorksheet = useSQLEditorStore((s) => s.maybeUpdateWorksheet);
+ const maybeUpdateSavedQuery = useSQLEditorStore(
+ (s) => s.maybeUpdateSavedQuery
+ );
const statement = useSQLEditorTabState(
(s) => s.tabsById.get(s.currentTabId)?.statement
@@ -55,10 +57,12 @@ export function useSQLEditorAutoSave() {
const runAutoSave = async () => {
const tabsState = getSQLEditorTabsState();
const tab = tabsState.tabsById.get(tabsState.currentTabId);
- if (!tab || !tab.worksheet || tab.status === "CLEAN") return;
+ if (!tab?.savedQuery || tab.status === "CLEAN") return;
- const worksheet = useAppStore.getState().getWorksheetByName(tab.worksheet);
- if (!worksheet || !isWorksheetWritableV1(worksheet)) return;
+ const savedQuery = useAppStore
+ .getState()
+ .getSavedQueryByName(tab.savedQuery);
+ if (!savedQuery || !isSavedQueryWritableV1(savedQuery)) return;
abortAutoSave();
@@ -71,9 +75,9 @@ export function useSQLEditorAutoSave() {
let wasAborted = false;
try {
- await maybeUpdateWorksheet({
+ await maybeUpdateSavedQuery({
tabId,
- worksheet: tab.worksheet,
+ savedQuery: tab.savedQuery,
database: tab.connection.database,
statement: statementToSave,
signal: controller.signal,
diff --git a/frontend/src/modules/sql-editor/legacy/migration.ts b/frontend/src/modules/sql-editor/legacy/migration.ts
index 38876abe27..8cee93bf5a 100644
--- a/frontend/src/modules/sql-editor/legacy/migration.ts
+++ b/frontend/src/modules/sql-editor/legacy/migration.ts
@@ -1,15 +1,15 @@
import { create } from "@bufbuild/protobuf";
import { isUndefined, omit, omitBy } from "lodash-es";
-import { extractWorksheetConnection } from "@/lib/sqlEditorConnection";
+import { extractSavedQueryConnection } from "@/lib/sqlEditorConnection";
import { useAppStore } from "@/stores/app";
import { getCurrentUserV1 } from "@/stores/modules/migration-helpers";
import { extractUserEmail } from "@/stores/modules/v1";
import type { EditorPanelViewState, SQLEditorTab } from "@/types";
import { DEFAULT_SQL_EDITOR_TAB_MODE } from "@/types";
import {
- Worksheet_Visibility,
- WorksheetSchema,
-} from "@/types/proto-es/v1/worksheet_service_pb";
+ SavedQuery_Visibility,
+ SavedQuerySchema,
+} from "@/types/proto-es/v1/saved_query_service_pb";
import { defaultSQLEditorTab, WebStorageHelper } from "@/utils";
import {
deleteExtendedTab,
@@ -53,10 +53,12 @@ const writeLegacyStorage = <T>(key: string, value: T): void => {
localStorage.setItem(key, serializeLegacy(value));
};
+// Legacy tabs were stored before the worksheet → saved query rename, so
+// the persisted shape keeps the historical `worksheet` field name.
type PersistentTab = Pick<
SQLEditorTab,
- "id" | "title" | "connection" | "mode" | "worksheet" | "status"
->;
+ "id" | "title" | "connection" | "mode" | "status"
+> & { worksheet?: string };
type LegacyStoredTab = PersistentTab & { statement?: string };
@@ -90,7 +92,12 @@ export const migrateLegacyCache = async () => {
...defaultSQLEditorTab(),
// Ignore extended fields stored in localStorage since they are migrated
// to extendedTabStore.
- ...omit(stored, EXTENDED_TAB_FIELDS),
+ ...omit(stored, [...EXTENDED_TAB_FIELDS, "worksheet"]),
+ // Legacy tabs stored the link under `worksheet` in the old name format.
+ savedQuery: (stored.worksheet ?? "").replace(
+ "/worksheets/",
+ "/savedQueries/"
+ ),
id,
};
if (tab.mode !== DEFAULT_SQL_EDITOR_TAB_MODE) {
@@ -160,16 +167,16 @@ export const migrateDraftsFromCache = async (project: string) => {
if ((!viewState || viewState.view === "CODE") && tab.statement) {
// only store the draft with content
try {
- const connection = await extractWorksheetConnection({
+ const connection = await extractSavedQueryConnection({
database: tab.connection.database,
});
- await useAppStore.getState().createWorksheet(
- create(WorksheetSchema, {
+ await useAppStore.getState().createSavedQuery(
+ create(SavedQuerySchema, {
title: tab.title,
database: connection.database,
content: new TextEncoder().encode(tab.statement),
project,
- visibility: Worksheet_Visibility.PRIVATE,
+ visibility: SavedQuery_Visibility.PRIVATE,
})
);
} catch {}
diff --git a/frontend/src/modules/sql-editor/model/Sheet/context.test.tsx b/frontend/src/modules/sql-editor/model/Sheet/context.test.tsx
index 9684ac841a..107083f60f 100644
--- a/frontend/src/modules/sql-editor/model/Sheet/context.test.tsx
+++ b/frontend/src/modules/sql-editor/model/Sheet/context.test.tsx
@@ -3,44 +3,44 @@ import { act } from "react";
import { createRoot, type Root } from "react-dom/client";
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
import {
- WorksheetSchema,
- Worksheet_Visibility,
- type Worksheet,
-} from "@/types/proto-es/v1/worksheet_service_pb";
+ SavedQuerySchema,
+ SavedQuery_Visibility,
+ type SavedQuery,
+} from "@/types/proto-es/v1/saved_query_service_pb";
import {
- storageKeySqlEditorWorksheetFilter,
- storageKeySqlEditorWorksheetFolder,
+ storageKeySqlEditorSavedQueryFilter,
+ storageKeySqlEditorSavedQueryFolder,
} from "@/utils";
type AppState = {
currentUser: { email: string; workspace: string };
- worksheetsByKey: Record<string, Worksheet>;
+ savedQueriesByKey: Record<string, SavedQuery>;
isSaaSMode: () => boolean;
- getWorksheetByName: (name: string) => Worksheet | undefined;
- listWorksheetFolders: ReturnType<typeof vi.fn>;
- fetchWorksheetList: ReturnType<typeof vi.fn>;
- upsertWorksheetOrganizer: ReturnType<typeof vi.fn>;
- batchUpdateWorksheetOrganizers: ReturnType<typeof vi.fn>;
+ getSavedQueryByName: (name: string) => SavedQuery | undefined;
+ listSavedQueryFolders: ReturnType<typeof vi.fn>;
+ fetchSavedQueryList: ReturnType<typeof vi.fn>;
+ upsertSavedQueryOrganizer: ReturnType<typeof vi.fn>;
+ batchUpdateSavedQueryOrganizers: ReturnType<typeof vi.fn>;
};
const mocks = vi.hoisted(() => {
let appState: AppState;
const appSubscribers = new Set<(state: AppState, prev: AppState) => void>();
- const keyForWorksheet = (name: string) => `${name.split("/").pop()}:FULL`;
+ const keyForSavedQuery = (name: string) => `${name.split("/").pop()}:FULL`;
- const setWorksheets = (worksheets: Worksheet[]) => {
+ const setSavedQueries = (savedQueries: SavedQuery[]) => {
const prev = {
...appState,
- worksheetsByKey: appState.worksheetsByKey,
+ savedQueriesByKey: appState.savedQueriesByKey,
};
appState = {
...appState,
- worksheetsByKey: {
- ...appState.worksheetsByKey,
+ savedQueriesByKey: {
+ ...appState.savedQueriesByKey,
...Object.fromEntries(
- worksheets.map((worksheet) => [
- keyForWorksheet(worksheet.name),
- worksheet,
+ savedQueries.map((savedQuery) => [
+ keyForSavedQuery(savedQuery.name),
+ savedQuery,
])
),
},
@@ -59,27 +59,27 @@ const mocks = vi.hoisted(() => {
workspace: "workspaces/default",
},
- worksheetsByKey: {},
+ savedQueriesByKey: {},
isSaaSMode: () => false,
- getWorksheetByName: (name: string) =>
- appState.worksheetsByKey[keyForWorksheet(name)],
- listWorksheetFolders: vi.fn(async () => []),
- fetchWorksheetList: vi.fn(async (_project, _filter, _params) => {
- const worksheet = create(WorksheetSchema, {
- name: "projects/proj1/worksheets/1",
+ getSavedQueryByName: (name: string) =>
+ appState.savedQueriesByKey[keyForSavedQuery(name)],
+ listSavedQueryFolders: vi.fn(async () => []),
+ fetchSavedQueryList: vi.fn(async (_project, _filter, _params) => {
+ const savedQuery = create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/1",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Existing worksheet",
- visibility: Worksheet_Visibility.PRIVATE,
+ title: "Existing saved query",
+ visibility: SavedQuery_Visibility.PRIVATE,
});
- setWorksheets([worksheet]);
- return { worksheets: [worksheet], nextPageToken: "next-page" };
+ setSavedQueries([savedQuery]);
+ return { savedQueries: [savedQuery], nextPageToken: "next-page" };
}),
- upsertWorksheetOrganizer: vi.fn(),
- batchUpdateWorksheetOrganizers: vi.fn(),
+ upsertSavedQueryOrganizer: vi.fn(),
+ batchUpdateSavedQueryOrganizers: vi.fn(),
};
},
- addWorksheets: setWorksheets,
+ addSavedQueries: setSavedQueries,
useAppStore: {
getState: () => appState,
subscribe: (subscriber: (state: AppState, prev: AppState) => void) => {
@@ -136,7 +136,7 @@ describe("sheet context", () => {
vi.resetModules();
});
- test("adds newly created worksheets to the initialized paged my view", async () => {
+ test("adds newly created saved queries to the initialized paged my view", async () => {
const { provideSheetContext, useSheetContextByView } = await import(
"./context"
);
@@ -161,7 +161,7 @@ describe("sheet context", () => {
await viewContext!.fetchSheetList();
});
- expect(container.textContent).toContain("Existing worksheet");
+ expect(container.textContent).toContain("Existing saved query");
expect(viewContext!.sheetTree.children.map((child) => child.label)).toContain(
"common.load-more"
);
@@ -169,25 +169,25 @@ describe("sheet context", () => {
"common.load-more"
);
- mocks.addWorksheets([
- create(WorksheetSchema, {
- name: "projects/proj1/worksheets/2",
+ mocks.addSavedQueries([
+ create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/2",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Created worksheet",
- visibility: Worksheet_Visibility.PRIVATE,
+ title: "Created saved query",
+ visibility: SavedQuery_Visibility.PRIVATE,
}),
]);
await act(async () => {
vi.runAllTimers();
});
- expect(container.textContent).toContain("Created worksheet");
+ expect(container.textContent).toContain("Created saved query");
});
- test("does not restore worksheet filter from localStorage", async () => {
+ test("does not restore saved query filter from localStorage", async () => {
window.localStorage.setItem(
- storageKeySqlEditorWorksheetFilter(
+ storageKeySqlEditorSavedQueryFilter(
"",
"projects/proj1",
@@ -224,8 +224,8 @@ describe("sheet context", () => {
});
});
- test("does not persist worksheet filter to localStorage", async () => {
- const key = storageKeySqlEditorWorksheetFilter(
+ test("does not persist saved query filter to localStorage", async () => {
+ const key = storageKeySqlEditorSavedQueryFilter(
"",
"projects/proj1",
@@ -257,7 +257,7 @@ describe("sheet context", () => {
});
test("uses a collision-free key for load-more rows", async () => {
- mocks.getAppState().listWorksheetFolders.mockResolvedValueOnce([
+ mocks.getAppState().listSavedQueryFolders.mockResolvedValueOnce([
{ folders: ["__load-more"], category: "my" },
]);
@@ -283,19 +283,19 @@ describe("sheet context", () => {
const keys = viewContext!.sheetTree.children.map((child) => child.key);
expect(keys).toContain("/my/__load-more");
- expect(keys).toContain("__worksheet_load_more__:/my");
+ expect(keys).toContain("__savedQuery_load_more__:/my");
});
- test("loads caller worksheet folders before the root worksheet page", async () => {
+ test("loads caller saved query folders before the root saved query page", async () => {
mocks
.getAppState()
- .listWorksheetFolders.mockResolvedValueOnce([
+ .listSavedQueryFolders.mockResolvedValueOnce([
{ folders: ["alpha"], category: "my" },
{ folders: ["alpha", "beta"], category: "my" },
{ folders: ["shared"], category: "shared" },
]);
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => ({
- worksheets: [],
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => ({
+ savedQueries: [],
nextPageToken: "",
}));
@@ -322,10 +322,10 @@ describe("sheet context", () => {
await viewContext!.fetchSheetList();
});
- expect(mocks.getAppState().listWorksheetFolders).toHaveBeenCalledWith(
+ expect(mocks.getAppState().listSavedQueryFolders).toHaveBeenCalledWith(
"projects/proj1"
);
- expect(mocks.getAppState().fetchWorksheetList).toHaveBeenCalledWith(
+ expect(mocks.getAppState().fetchSavedQueryList).toHaveBeenCalledWith(
"projects/proj1",
'creator == "users/[email protected]" && folder == ""',
expect.objectContaining({ pageToken: "" })
@@ -336,7 +336,7 @@ describe("sheet context", () => {
test("merges persisted empty folders with backend folders", async () => {
window.localStorage.setItem(
- storageKeySqlEditorWorksheetFolder(
+ storageKeySqlEditorSavedQueryFolder(
"",
"projects/proj1",
"shared",
@@ -344,11 +344,11 @@ describe("sheet context", () => {
),
JSON.stringify(["/shared/alpha", "/shared/local-empty"])
);
- mocks.getAppState().listWorksheetFolders.mockResolvedValueOnce([
+ mocks.getAppState().listSavedQueryFolders.mockResolvedValueOnce([
{ folders: ["alpha"], category: "my" },
]);
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => ({
- worksheets: [],
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => ({
+ savedQueries: [],
nextPageToken: "",
}));
@@ -403,7 +403,7 @@ describe("sheet context", () => {
expect(
JSON.parse(
window.localStorage.getItem(
- storageKeySqlEditorWorksheetFolder(
+ storageKeySqlEditorSavedQueryFolder(
"",
"projects/proj1",
"my",
@@ -414,7 +414,7 @@ describe("sheet context", () => {
).toEqual(["/my/local-empty"]);
});
- test("uses server-side keyword and starred filters when fetching worksheets", async () => {
+ test("uses server-side keyword and starred filters when fetching saved queries", async () => {
const { provideSheetContext, useSheetContext, useSheetContextByView } =
await import("./context");
let sheetContext: ReturnType<typeof useSheetContext> | undefined;
@@ -434,7 +434,7 @@ describe("sheet context", () => {
await act(async () => {
await viewContext!.fetchSheetList();
});
- mocks.getAppState().fetchWorksheetList.mockClear();
+ mocks.getAppState().fetchSavedQueryList.mockClear();
act(() => {
sheetContext!.setFilter({
@@ -447,18 +447,18 @@ describe("sheet context", () => {
await vi.runAllTimersAsync();
});
- expect(mocks.getAppState().fetchWorksheetList).toHaveBeenLastCalledWith(
+ expect(mocks.getAppState().fetchSavedQueryList).toHaveBeenLastCalledWith(
"projects/proj1",
'creator == "users/[email protected]" && folder == "" && title.contains("payroll") && starred == true',
expect.objectContaining({ pageToken: "" })
);
- mocks.getAppState().fetchWorksheetList.mockClear();
+ mocks.getAppState().fetchSavedQueryList.mockClear();
await act(async () => {
await viewContext!.fetchNextPage();
});
- expect(mocks.getAppState().fetchWorksheetList).toHaveBeenLastCalledWith(
+ expect(mocks.getAppState().fetchSavedQueryList).toHaveBeenLastCalledWith(
"projects/proj1",
'creator == "users/[email protected]" && folder == "" && title.contains("payroll") && starred == true',
expect.objectContaining({ pageToken: "next-page" })
@@ -468,11 +468,11 @@ describe("sheet context", () => {
test("keeps backend-known folders visible when starred filter is active", async () => {
mocks
.getAppState()
- .listWorksheetFolders.mockResolvedValue([
+ .listSavedQueryFolders.mockResolvedValue([
{ folders: ["alpha"], category: "my" },
]);
- mocks.getAppState().fetchWorksheetList.mockResolvedValue({
- worksheets: [],
+ mocks.getAppState().fetchSavedQueryList.mockResolvedValue({
+ savedQueries: [],
nextPageToken: "",
});
@@ -499,7 +499,7 @@ describe("sheet context", () => {
await act(async () => {
await viewContext!.fetchSheetList();
});
- mocks.getAppState().fetchWorksheetList.mockClear();
+ mocks.getAppState().fetchSavedQueryList.mockClear();
act(() => {
sheetContext!.setFilter({
@@ -511,7 +511,7 @@ describe("sheet context", () => {
await vi.runAllTimersAsync();
});
- expect(mocks.getAppState().fetchWorksheetList).toHaveBeenLastCalledWith(
+ expect(mocks.getAppState().fetchSavedQueryList).toHaveBeenLastCalledWith(
"projects/proj1",
'creator == "users/[email protected]" && folder == "" && starred == true',
expect.objectContaining({ pageToken: "" })
@@ -519,7 +519,7 @@ describe("sheet context", () => {
expect(container.textContent).toContain("alpha");
});
- test("fetches worksheet descendants for a folder without replacing the paged view", async () => {
+ test("fetches saved query descendants for a folder without replacing the paged view", async () => {
const { provideSheetContext, useSheetContextByView } = await import(
"./context"
);
@@ -543,32 +543,32 @@ describe("sheet context", () => {
await viewContext!.fetchSheetList();
});
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
- const worksheet = create(WorksheetSchema, {
- name: "projects/proj1/worksheets/3",
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => {
+ const savedQuery = create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/3",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Folder worksheet",
+ title: "Folder saved query",
folders: ["alpha"],
- visibility: Worksheet_Visibility.PRIVATE,
+ visibility: SavedQuery_Visibility.PRIVATE,
});
- mocks.addWorksheets([worksheet]);
+ mocks.addSavedQueries([savedQuery]);
return {
- worksheets: [worksheet],
+ savedQueries: [savedQuery],
nextPageToken: "",
};
});
await act(async () => {
- await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ await viewContext!.fetchSavedQueriesByFolder("/my/alpha");
});
- expect(mocks.getAppState().fetchWorksheetList).toHaveBeenLastCalledWith(
+ expect(mocks.getAppState().fetchSavedQueryList).toHaveBeenLastCalledWith(
"projects/proj1",
'creator == "users/[email protected]" && folder == "alpha"',
expect.objectContaining({ pageToken: "" })
);
- expect(container.textContent).toContain("Existing worksheet");
+ expect(container.textContent).toContain("Existing saved query");
expect(container.textContent).toContain("alpha");
});
@@ -592,23 +592,23 @@ describe("sheet context", () => {
await viewContext!.fetchSheetList();
});
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
- const worksheet = create(WorksheetSchema, {
- name: "projects/proj1/worksheets/3",
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => {
+ const savedQuery = create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/3",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Folder worksheet",
+ title: "Folder saved query",
folders: ["alpha"],
- visibility: Worksheet_Visibility.PRIVATE,
+ visibility: SavedQuery_Visibility.PRIVATE,
});
- mocks.addWorksheets([worksheet]);
+ mocks.addSavedQueries([savedQuery]);
return {
- worksheets: [worksheet],
+ savedQueries: [savedQuery],
nextPageToken: "folder-next",
};
});
await act(async () => {
- await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ await viewContext!.fetchSavedQueriesByFolder("/my/alpha");
});
const alpha = viewContext!.sheetTree.children.find(
@@ -618,33 +618,33 @@ describe("sheet context", () => {
"common.load-more"
);
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => ({
- worksheets: [],
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => ({
+ savedQueries: [],
nextPageToken: "",
}));
await act(async () => {
await viewContext!.fetchNextPage("/my/alpha");
});
- expect(mocks.getAppState().fetchWorksheetList).toHaveBeenLastCalledWith(
+ expect(mocks.getAppState().fetchSavedQueryList).toHaveBeenLastCalledWith(
"projects/proj1",
'creator == "users/[email protected]" && folder == "alpha"',
expect.objectContaining({ pageToken: "folder-next" })
);
});
- test("appends newly fetched worksheet pages without frontend reordering", async () => {
- const firstWorksheet = create(WorksheetSchema, {
- name: "projects/proj1/worksheets/first",
+ test("appends newly fetched saved query pages without frontend reordering", async () => {
+ const firstSavedQuery = create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/first",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Zeta worksheet",
- visibility: Worksheet_Visibility.PRIVATE,
+ title: "Zeta saved query",
+ visibility: SavedQuery_Visibility.PRIVATE,
});
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
- mocks.addWorksheets([firstWorksheet]);
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => {
+ mocks.addSavedQueries([firstSavedQuery]);
return {
- worksheets: [firstWorksheet],
+ savedQueries: [firstSavedQuery],
nextPageToken: "next-page",
};
});
@@ -668,17 +668,17 @@ describe("sheet context", () => {
await viewContext!.fetchSheetList();
});
- const secondWorksheet = create(WorksheetSchema, {
- name: "projects/proj1/worksheets/second",
+ const secondSavedQuery = create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/second",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Alpha worksheet",
- visibility: Worksheet_Visibility.PRIVATE,
+ title: "Alpha saved query",
+ visibility: SavedQuery_Visibility.PRIVATE,
});
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
- mocks.addWorksheets([secondWorksheet]);
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => {
+ mocks.addSavedQueries([secondSavedQuery]);
return {
- worksheets: [secondWorksheet],
+ savedQueries: [secondSavedQuery],
nextPageToken: "",
};
});
@@ -688,9 +688,9 @@ describe("sheet context", () => {
expect(
viewContext!.sheetTree.children
- .filter((child) => child.worksheet)
+ .filter((child) => child.savedQuery)
.map((child) => child.label)
- ).toEqual(["Zeta worksheet", "Alpha worksheet"]);
+ ).toEqual(["Zeta saved query", "Alpha saved query"]);
});
test("keeps folder and descendant load-more state after renaming a folder", async () => {
@@ -713,44 +713,44 @@ describe("sheet context", () => {
await viewContext!.fetchSheetList();
});
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
- const worksheet = create(WorksheetSchema, {
- name: "projects/proj1/worksheets/3",
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => {
+ const savedQuery = create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/3",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Folder worksheet",
+ title: "Folder saved query",
folders: ["alpha"],
- visibility: Worksheet_Visibility.PRIVATE,
+ visibility: SavedQuery_Visibility.PRIVATE,
});
- mocks.addWorksheets([worksheet]);
+ mocks.addSavedQueries([savedQuery]);
return {
- worksheets: [worksheet],
+ savedQueries: [savedQuery],
nextPageToken: "folder-next",
};
});
await act(async () => {
- await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ await viewContext!.fetchSavedQueriesByFolder("/my/alpha");
});
expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(true);
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
- const worksheet = create(WorksheetSchema, {
- name: "projects/proj1/worksheets/4",
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => {
+ const savedQuery = create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/4",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Child folder worksheet",
+ title: "Child folder saved query",
folders: ["alpha", "child"],
- visibility: Worksheet_Visibility.PRIVATE,
+ visibility: SavedQuery_Visibility.PRIVATE,
});
- mocks.addWorksheets([worksheet]);
+ mocks.addSavedQueries([savedQuery]);
return {
- worksheets: [worksheet],
+ savedQueries: [savedQuery],
nextPageToken: "child-folder-next",
};
});
await act(async () => {
- await viewContext!.fetchWorksheetsByFolder("/my/alpha/child");
+ await viewContext!.fetchSavedQueriesByFolder("/my/alpha/child");
});
expect(viewContext!.hasMoreForFolder("/my/alpha/child")).toBe(true);
@@ -787,23 +787,23 @@ describe("sheet context", () => {
viewContext!.folderContext.addFolder("/my/beta");
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
- const worksheet = create(WorksheetSchema, {
- name: "projects/proj1/worksheets/3",
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => {
+ const savedQuery = create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/3",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Alpha worksheet",
+ title: "Alpha saved query",
folders: ["alpha"],
- visibility: Worksheet_Visibility.PRIVATE,
+ visibility: SavedQuery_Visibility.PRIVATE,
});
- mocks.addWorksheets([worksheet]);
+ mocks.addSavedQueries([savedQuery]);
return {
- worksheets: [worksheet],
+ savedQueries: [savedQuery],
nextPageToken: "alpha-next",
};
});
await act(async () => {
- await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ await viewContext!.fetchSavedQueriesByFolder("/my/alpha");
});
expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(true);
@@ -817,7 +817,7 @@ describe("sheet context", () => {
expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(false);
});
- test("invalidates affected page tokens after moving worksheets", async () => {
+ test("invalidates affected page tokens after moving saved queries", async () => {
const { provideSheetContext, useSheetContext, useSheetContextByView } =
await import("./context");
let sheetContext: ReturnType<typeof useSheetContext> | undefined;
@@ -838,31 +838,31 @@ describe("sheet context", () => {
await viewContext!.fetchSheetList();
});
- mocks.getAppState().fetchWorksheetList.mockImplementationOnce(async () => {
- const worksheet = create(WorksheetSchema, {
- name: "projects/proj1/worksheets/3",
+ mocks.getAppState().fetchSavedQueryList.mockImplementationOnce(async () => {
+ const savedQuery = create(SavedQuerySchema, {
+ name: "projects/proj1/savedQueries/3",
project: "projects/proj1",
creator: "users/[email protected]",
- title: "Folder worksheet",
+ title: "Folder saved query",
folders: ["alpha"],
- visibility: Worksheet_Visibility.PRIVATE,
+ visibility: SavedQuery_Visibility.PRIVATE,
});
- mocks.addWorksheets([worksheet]);
+ mocks.addSavedQueries([savedQuery]);
return {
- worksheets: [worksheet],
+ savedQueries: [savedQuery],
nextPageToken: "folder-next",
};
});
await act(async () => {
- await viewContext!.fetchWorksheetsByFolder("/my/alpha");
+ await viewContext!.fetchSavedQueriesByFolder("/my/alpha");
});
expect(viewContext!.hasMore).toBe(true);
expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(true);
await act(async () => {
- await sheetContext!.batchUpdateWorksheetFolders([
- { name: "projects/proj1/worksheets/1", folders: ["alpha"] },
+ await sheetContext!.batchUpdateSavedQueryFolders([
+ { name: "projects/proj1/savedQueries/1", folders: ["alpha"] },
]);
});
@@ -870,7 +870,7 @@ describe("sheet context", () => {
expect(viewContext!.hasMoreForFolder("/my/alpha")).toBe(false);
});
- test("batch updates worksheet folders with one name filter per target folder", async () => {
+ test("batch updates saved query folders with one name filter per target folder", async () => {
const { provideSheetContext, useSheetContext } = await import("./context");
let sheetContext: ReturnType<typeof useSheetContext> | undefined;
@@ -886,27 +886,27 @@ describe("sheet context", () => {
});
await act(async () => {
- await sheetContext!.batchUpdateWorksheetFolders([
- { name: "projects/proj1/worksheets/1", folders: ["target"] },
- { name: "projects/proj1/worksheets/2", folders: ["target"] },
+ await sheetContext!.batchUpdateSavedQueryFolders([
+ { name: "projects/proj1/savedQueries/1", folders: ["target"] },
+ { name: "projects/proj1/savedQueries/2", folders: ["target"] },
]);
});
- expect(mocks.getAppState().upsertWorksheetOrganizer).not.toHaveBeenCalled();
+ expect(mocks.getAppState().upsertSavedQueryOrganizer).not.toHaveBeenCalled();
expect(
- mocks.getAppState().batchUpdateWorksheetOrganizers
+ mocks.getAppState().batchUpdateSavedQueryOrganizers
).toHaveBeenCalledWith([
{
parent: "projects/proj1",
filter:
- 'name in ["projects/proj1/worksheets/1","projects/proj1/worksheets/2"]',
+ 'name in ["projects/proj1/savedQueries/1","projects/proj1/savedQueries/2"]',
organizer: { folders: ["target"] },
updateMask: ["folders"],
},
]);
});
- test("batch updates worksheet folder paths without display filters", async () => {
+ test("batch updates saved query folder paths without display filters", async () => {
const { provideSheetContext, useSheetContext } = await import("./context");
let sheetContext: ReturnType<typeof useSheetContext> | undefined;
@@ -929,14 +929,14 @@ describe("sheet context", () => {
});
await act(async () => {
- await sheetContext!.batchUpdateWorksheetFolderPaths("my", [
+ await sheetContext!.batchUpdateSavedQueryFolderPaths("my", [
{ sourceFolder: ["old"], targetFolder: ["new"] },
{ sourceFolder: ["old", "child"], targetFolder: ["new", "child"] },
]);
});
expect(
- mocks.getAppState().batchUpdateWorksheetOrganizers
+ mocks.getAppState().batchUpdateSavedQueryOrganizers
).toHaveBeenCalledWith([
{
parent: "projects/proj1",
diff --git a/frontend/src/modules/sql-editor/model/Sheet/context.ts b/frontend/src/modules/sql-editor/model/Sheet/context.ts
index 14147b752b..7b669f13fd 100644
--- a/frontend/src/modules/sql-editor/model/Sheet/context.ts
+++ b/frontend/src/modules/sql-editor/model/Sheet/context.ts
@@ -6,7 +6,7 @@ import { create, type StoreApi, type UseBoundStore } from "zustand";
import { immer } from "zustand/middleware/immer";
import { useShallow } from "zustand/react/shallow";
import i18n from "@/lib/i18n";
-import { extractWorksheetConnection } from "@/lib/sqlEditorConnection";
+import { extractSavedQueryConnection } from "@/lib/sqlEditorConnection";
import {
getSQLEditorEditorState,
subscribeSQLEditorEditorState,
@@ -21,35 +21,35 @@ import { useAppStore } from "@/stores/app";
import type { SQLEditorTab, SQLEditorTabMode } from "@/types";
import { DEBOUNCE_SEARCH_DELAY } from "@/types";
import {
- type Worksheet,
- Worksheet_Visibility,
-} from "@/types/proto-es/v1/worksheet_service_pb";
+ type SavedQuery,
+ SavedQuery_Visibility,
+} from "@/types/proto-es/v1/saved_query_service_pb";
import {
getDefaultPagination,
getSheetStatement,
- isWorksheetReadableV1,
- storageKeySqlEditorWorksheetFolder,
- storageKeySqlEditorWorksheetTree,
+ isSavedQueryReadableV1,
+ storageKeySqlEditorSavedQueryFolder,
+ storageKeySqlEditorSavedQueryTree,
workspaceCacheScope,
} from "@/utils";
import { escapeCELStringLiteral } from "@/utils/v1/cel";
import { isSubFolder } from "./folder";
import { type SheetViewMode, SheetViewModeList } from "./types";
-// Worksheet caches, folder sets, and the sheet-tree contain Map / Set
+// SavedQuery caches, folder sets, and the sheet-tree contain Map / Set
// values that immer needs to draft directly via mutation.
enableMapSet();
// ---- public types ----------------------------------------------------------
-export interface WorksheetLikeItem {
+export interface SavedQueryLikeItem {
name: string;
title: string;
folders: string[];
- type: "worksheet" | "draft";
+ type: "savedQuery" | "draft";
}
-export interface WorksheetFolderNode {
+export interface SavedQueryFolderNode {
key: string;
label: string;
editable: boolean;
@@ -57,12 +57,12 @@ export interface WorksheetFolderNode {
empty?: boolean;
loadMore?: boolean;
loadMoreFolderKey?: string;
- worksheet?: WorksheetLikeItem;
- children: WorksheetFolderNode[];
+ savedQuery?: SavedQueryLikeItem;
+ children: SavedQueryFolderNode[];
[key: string]: unknown;
}
-export interface WorksheetFilter {
+export interface SavedQueryFilter {
keyword: string;
onlyShowStarred: boolean;
showMine: boolean;
@@ -94,31 +94,31 @@ type SheetTreeEvents = Emittery<{
export interface ViewContext {
isLoading: boolean;
isInitialized: boolean;
- sheetTree: WorksheetFolderNode;
- folderTree: WorksheetFolderNode;
+ sheetTree: SavedQueryFolderNode;
+ folderTree: SavedQueryFolderNode;
folderContext: FolderContext;
events: SheetTreeEvents;
fetchSheetList: () => Promise<void>;
fetchNextPage: (folderKey?: string) => Promise<void>;
- fetchWorksheetsByFolder: (folderKey: string) => Promise<void>;
+ fetchSavedQueriesByFolder: (folderKey: string) => Promise<void>;
hasMore: boolean;
hasMoreForFolder: (folderKey: string) => boolean;
isFetchingNextPage: boolean;
rebuildTree: () => void;
- getKeyForWorksheet: (worksheet: WorksheetLikeItem) => string;
- getFoldersForWorksheet: (path: string) => string[];
- getPathesForWorksheet: (worksheet: { folders: string[] }) => string[];
- getPwdForWorksheet: (worksheet: { folders: string[] }) => string;
+ getKeyForSavedQuery: (savedQuery: SavedQueryLikeItem) => string;
+ getFoldersForSavedQuery: (path: string) => string[];
+ getPathesForSavedQuery: (savedQuery: { folders: string[] }) => string[];
+ getPwdForSavedQuery: (savedQuery: { folders: string[] }) => string;
}
-export type WorksheetFolderPathUpdate = {
+export type SavedQueryFolderPathUpdate = {
sourceFolder: string[];
targetFolder: string[];
};
// ---- internal Zustand store ------------------------------------------------
-const INITIAL_FILTER: WorksheetFilter = {
+const INITIAL_FILTER: SavedQueryFilter = {
keyword: "",
showShared: true,
showMine: true,
@@ -130,9 +130,9 @@ interface ViewState {
isLoading: boolean;
isFetchingNextPage: boolean;
isInitialized: boolean;
- sheetTree: WorksheetFolderNode;
+ sheetTree: SavedQueryFolderNode;
folders: string[];
- worksheetNames: string[];
+ savedQueryNames: string[];
nextPageToken: string;
folderNextPageTokens: Map<string, string>;
fetchingFolderKeys: Set<string>;
@@ -140,15 +140,15 @@ interface ViewState {
}
interface SheetContextState {
- filter: WorksheetFilter;
+ filter: SavedQueryFilter;
expandedKeys: Set<string>;
selectedKeys: string[];
- editingNode: { node: WorksheetFolderNode; rawLabel: string } | undefined;
+ editingNode: { node: SavedQueryFolderNode; rawLabel: string } | undefined;
view: SheetViewMode;
viewStates: Record<SheetViewMode, ViewState>;
setFilter: (
- next: WorksheetFilter | ((prev: WorksheetFilter) => WorksheetFilter)
+ next: SavedQueryFilter | ((prev: SavedQueryFilter) => SavedQueryFilter)
) => void;
setView: (view: SheetViewMode) => void;
setExpandedKeys: (
@@ -156,14 +156,14 @@ interface SheetContextState {
) => void;
setSelectedKeys: (next: string[]) => void;
setEditingNode: (
- next: { node: WorksheetFolderNode; rawLabel: string } | undefined
+ next: { node: SavedQueryFolderNode; rawLabel: string } | undefined
) => void;
setViewIsLoading: (view: SheetViewMode, loading: boolean) => void;
setViewIsFetchingNextPage: (view: SheetViewMode, loading: boolean) => void;
setViewIsInitialized: (view: SheetViewMode, initialized: boolean) => void;
- setViewSheetTree: (view: SheetViewMode, tree: WorksheetFolderNode) => void;
+ setViewSheetTree: (view: SheetViewMode, tree: SavedQueryFolderNode) => void;
setViewFolders: (view: SheetViewMode, folders: string[]) => void;
- setViewWorksheetNames: (view: SheetViewMode, names: string[]) => void;
+ setViewSavedQueryNames: (view: SheetViewMode, names: string[]) => void;
setViewNextPageToken: (view: SheetViewMode, token: string) => void;
setViewFolderNextPageToken: (
view: SheetViewMode,
@@ -193,7 +193,7 @@ interface SheetContextState {
const rootPathFor = (view: SheetViewMode) => `/${view}`;
-const emptyRootNode = (view: SheetViewMode): WorksheetFolderNode => ({
+const emptyRootNode = (view: SheetViewMode): SavedQueryFolderNode => ({
key: rootPathFor(view),
label: "",
editable: false,
@@ -207,7 +207,7 @@ const emptyViewState = (view: SheetViewMode): ViewState => ({
isInitialized: false,
sheetTree: emptyRootNode(view),
folders: [rootPathFor(view)],
- worksheetNames: [],
+ savedQueryNames: [],
nextPageToken: "",
folderNextPageTokens: new Map<string, string>(),
fetchingFolderKeys: new Set<string>(),
@@ -285,9 +285,9 @@ const useSheetContextStore: UseBoundStore<StoreApi<SheetContextState>> =
s.viewStates[view].folders = folders;
});
},
- setViewWorksheetNames(view, names) {
+ setViewSavedQueryNames(view, names) {
set((s) => {
- s.viewStates[view].worksheetNames = names;
+ s.viewStates[view].savedQueryNames = names;
});
},
setViewNextPageToken(view, token) {
@@ -446,7 +446,11 @@ const reloadFromStorage = () => {
if (!scope) return;
const expandedArray = safeReadJSON<string[]>(
- storageKeySqlEditorWorksheetTree(scope.wsScope, scope.project, scope.email),
+ storageKeySqlEditorSavedQueryTree(
+ scope.wsScope,
+ scope.project,
+ scope.email
+ ),
(v) =>
Array.isArray(v) && v.every((entry) => typeof entry === "string")
? (v as string[])
@@ -488,7 +492,11 @@ const persistExpandedKeys = (keys: Set<string>) => {
const scope = currentScope();
if (!scope) return;
safeWriteJSON(
- storageKeySqlEditorWorksheetTree(scope.wsScope, scope.project, scope.email),
+ storageKeySqlEditorSavedQueryTree(
+ scope.wsScope,
+ scope.project,
+ scope.email
+ ),
[...keys]
);
};
@@ -496,7 +504,7 @@ const persistExpandedKeys = (keys: Set<string>) => {
const persistedFolderStorageKey = (view: SheetViewMode): string | undefined => {
const scope = currentScope();
if (!scope) return undefined;
- return storageKeySqlEditorWorksheetFolder(
+ return storageKeySqlEditorSavedQueryFolder(
scope.wsScope,
scope.project,
view,
@@ -565,13 +573,13 @@ const movePersistedFolder = (view: SheetViewMode, from: string, to: string) => {
// ---- per-view helpers + folder context -------------------------------------
-const convertToWorksheetLikeItem = (
- worksheet: Worksheet
-): WorksheetLikeItem => ({
- name: worksheet.name,
- title: worksheet.title,
- folders: worksheet.folders,
- type: "worksheet",
+const convertToSavedQueryLikeItem = (
+ savedQuery: SavedQuery
+): SavedQueryLikeItem => ({
+ name: savedQuery.name,
+ title: savedQuery.title,
+ folders: savedQuery.folders,
+ type: "savedQuery",
});
const rootLabelFor = (view: SheetViewMode): string => {
@@ -587,7 +595,7 @@ const rootLabelFor = (view: SheetViewMode): string => {
}
};
-const rootTreeNodeFor = (view: SheetViewMode): WorksheetFolderNode => ({
+const rootTreeNodeFor = (view: SheetViewMode): SavedQueryFolderNode => ({
isLeaf: false,
children: [],
key: rootPathFor(view),
@@ -596,7 +604,7 @@ const rootTreeNodeFor = (view: SheetViewMode): WorksheetFolderNode => ({
});
const getLoadMoreNodeKey = (folderKey: string) =>
- `__worksheet_load_more__:${folderKey}`;
+ `__savedQuery_load_more__:${folderKey}`;
const ensureFolderPath = (view: SheetViewMode, path: string): string => {
const root = rootPathFor(view);
@@ -722,36 +730,36 @@ const getEvents = (view: SheetViewMode): SheetTreeEvents => {
return events;
};
-const getPathesForWorksheet = (
+const getPathesForSavedQuery = (
view: SheetViewMode,
- worksheet: { folders: string[] }
+ savedQuery: { folders: string[] }
): string[] => {
const folderContext = getFolderContext(view);
const pathes = [folderContext.rootPath];
let currentPath = folderContext.rootPath;
- for (const folder of worksheet.folders) {
+ for (const folder of savedQuery.folders) {
currentPath = folderContext.ensureFolderPath(`${currentPath}/${folder}`);
pathes.push(currentPath);
}
return pathes;
};
-const getPwdForWorksheet = (
+const getPwdForSavedQuery = (
view: SheetViewMode,
- worksheet: { folders: string[] }
+ savedQuery: { folders: string[] }
): string =>
- getFolderContext(view).ensureFolderPath(worksheet.folders.join("/"));
+ getFolderContext(view).ensureFolderPath(savedQuery.folders.join("/"));
-const getKeyForWorksheet = (
+const getKeyForSavedQuery = (
view: SheetViewMode,
- worksheet: WorksheetLikeItem
+ savedQuery: SavedQueryLikeItem
): string =>
[
- getPwdForWorksheet(view, worksheet),
- `bytebase-${worksheet.type}-${worksheet.name.split("/").slice(-1)[0]}.sql`,
+ getPwdForSavedQuery(view, savedQuery),
+ `bytebase-${savedQuery.type}-${savedQuery.name.split("/").at(-1)}.sql`,
].join("/");
-const getFoldersForWorksheet = (
+const getFoldersForSavedQuery = (
view: SheetViewMode,
path: string
): string[] => {
@@ -763,13 +771,13 @@ const getFoldersForWorksheet = (
const buildTree = (
view: SheetViewMode,
- parent: WorksheetFolderNode,
- worksheetsByFolder: Map<string, WorksheetLikeItem[]>,
+ parent: SavedQueryFolderNode,
+ savedQueriesByFolder: Map<string, SavedQueryLikeItem[]>,
hideEmpty: boolean,
includeLoadMore = true
-): WorksheetFolderNode => {
+): SavedQueryFolderNode => {
const folderContext = getFolderContext(view);
- const subfolders: WorksheetFolderNode[] = folderContext
+ const subfolders: SavedQueryFolderNode[] = folderContext
.listSubFolders(parent.key)
.map((folder) => ({
isLeaf: false,
@@ -784,7 +792,7 @@ const buildTree = (
const subtree = buildTree(
view,
childNode,
- worksheetsByFolder,
+ savedQueriesByFolder,
hideEmpty,
includeLoadMore
);
@@ -797,12 +805,12 @@ const buildTree = (
}
const sheets = (
- worksheetsByFolder.get(parent.key) ?? []
- ).map<WorksheetFolderNode>((worksheet) => ({
+ savedQueriesByFolder.get(parent.key) ?? []
+ ).map<SavedQueryFolderNode>((savedQuery) => ({
isLeaf: true,
- key: getKeyForWorksheet(view, worksheet),
- label: worksheet.title,
- worksheet,
+ key: getKeyForSavedQuery(view, savedQuery),
+ label: savedQuery.title,
+ savedQuery,
editable: true,
children: [],
}));
@@ -814,7 +822,7 @@ const buildTree = (
? !!viewState.nextPageToken
: viewState.folderNextPageTokens.has(parent.key);
if (includeLoadMore && hasMore) {
- const loadMoreNode: WorksheetFolderNode = {
+ const loadMoreNode: SavedQueryFolderNode = {
key: getLoadMoreNodeKey(parent.key),
label: i18n.t("common.load-more"),
editable: false,
@@ -832,24 +840,24 @@ const buildTree = (
return parent;
};
-const worksheetsForView = (view: SheetViewMode): Worksheet[] => {
+const savedQueriesForView = (view: SheetViewMode): SavedQuery[] => {
if (view !== "my" && view !== "shared") return [];
const filter = useSheetContextStore.getState().filter;
const project = getSQLEditorEditorState().project;
// SQLEditorLayout awaits `loadCurrentUser()` in its bootstrap, so by the
- // time worksheets land here the app-store `currentUser` is populated.
+ // time saved queries land here the app-store `currentUser` is populated.
// Empty `email` falls through to creator `"users/"`, which matches no
- // worksheets — they'd render as Shared rather than Mine, same fallback
+ // saved queries — they'd render as Shared rather than Mine, same fallback
// the previous Pinia path had.
const email = useAppStore.getState().currentUser?.email ?? "";
const creator = `users/${email}`;
const appState = useAppStore.getState();
let list = useSheetContextStore
.getState()
- .viewStates[view].worksheetNames.map((name) =>
- appState.getWorksheetByName(name)
+ .viewStates[view].savedQueryNames.map((name) =>
+ appState.getSavedQueryByName(name)
)
- .filter((sheet): sheet is Worksheet => {
+ .filter((sheet): sheet is SavedQuery => {
if (!sheet) return false;
if (sheet.project !== project) return false;
const mine = sheet.creator === creator;
@@ -861,12 +869,12 @@ const worksheetsForView = (view: SheetViewMode): Worksheet[] => {
return list;
};
-const sheetLikeItemsForView = (view: SheetViewMode): WorksheetLikeItem[] => {
+const sheetLikeItemsForView = (view: SheetViewMode): SavedQueryLikeItem[] => {
if (view === "draft") {
const tabsState = getSQLEditorTabsState();
return tabsState.openTmpTabList
.map((p) => tabsState.tabsById.get(p.id))
- .filter((tab): tab is SQLEditorTab => !!tab && !tab.worksheet)
+ .filter((tab): tab is SQLEditorTab => !!tab && !tab.savedQuery)
.map((tab) => ({
name: tab.id,
title: tab.title,
@@ -874,32 +882,32 @@ const sheetLikeItemsForView = (view: SheetViewMode): WorksheetLikeItem[] => {
type: "draft" as const,
}));
}
- return worksheetsForView(view).map(convertToWorksheetLikeItem);
+ return savedQueriesForView(view).map(convertToSavedQueryLikeItem);
};
const rebuildTreeImpl = (view: SheetViewMode) => {
const folderContext = getFolderContext(view);
const folderPaths = new Set<string>();
- const worksheetsByFolder = new Map<string, WorksheetLikeItem[]>();
+ const savedQueriesByFolder = new Map<string, SavedQueryLikeItem[]>();
- for (const worksheet of sheetLikeItemsForView(view)) {
- for (const path of getPathesForWorksheet(view, worksheet)) {
+ for (const savedQuery of sheetLikeItemsForView(view)) {
+ for (const path of getPathesForSavedQuery(view, savedQuery)) {
folderPaths.add(path);
}
- const pwd = getPwdForWorksheet(view, worksheet);
- if (!worksheetsByFolder.has(pwd)) worksheetsByFolder.set(pwd, []);
- worksheetsByFolder.get(pwd)!.push(worksheet);
+ const pwd = getPwdForSavedQuery(view, savedQuery);
+ if (!savedQueriesByFolder.has(pwd)) savedQueriesByFolder.set(pwd, []);
+ savedQueriesByFolder.get(pwd)!.push(savedQuery);
}
folderContext.mergeFolders(folderPaths);
- const root: WorksheetFolderNode = {
+ const root: SavedQueryFolderNode = {
...rootTreeNodeFor(view),
label: rootLabelFor(view),
key: folderContext.rootPath,
};
- const tree = buildTree(view, root, worksheetsByFolder, false);
+ const tree = buildTree(view, root, savedQueriesByFolder, false);
useSheetContextStore.getState().setViewSheetTree(view, tree);
getEvents(view).emit("on-built", { viewMode: view });
};
@@ -921,13 +929,15 @@ const fetchSheetListFor = async (view: SheetViewMode) => {
state.setViewIsLoading(view, true);
try {
state.resetViewFolderPageState(view);
- await fetchWorksheetFoldersForView(view);
- const { worksheets, nextPageToken } = await fetchWorksheetsPage(view, "", [
- `folder == ""`,
- ]);
- state.setViewWorksheetNames(
+ await fetchSavedQueryFoldersForView(view);
+ const { savedQueries, nextPageToken } = await fetchSavedQueriesPage(
+ view,
+ "",
+ [`folder == ""`]
+ );
+ state.setViewSavedQueryNames(
view,
- worksheets.map((worksheet) => worksheet.name)
+ savedQueries.map((savedQuery) => savedQuery.name)
);
state.setViewNextPageToken(view, nextPageToken);
rebuildTreeImpl(view);
@@ -962,18 +972,18 @@ const fetchNextSheetPageFor = async (
state.setViewIsFetchingNextPage(view, true);
try {
- const { worksheets, nextPageToken } = await fetchWorksheetsPage(
+ const { savedQueries, nextPageToken } = await fetchSavedQueriesPage(
view,
pageToken,
[folderFilterForKey(view, key)]
);
const names = new Set(
- useSheetContextStore.getState().viewStates[view].worksheetNames
+ useSheetContextStore.getState().viewStates[view].savedQueryNames
);
- for (const worksheet of worksheets) {
- names.add(worksheet.name);
+ for (const savedQuery of savedQueries) {
+ names.add(savedQuery.name);
}
- state.setViewWorksheetNames(view, [...names]);
+ state.setViewSavedQueryNames(view, [...names]);
if (key === folderContext.rootPath) {
state.setViewNextPageToken(view, nextPageToken);
} else {
@@ -991,11 +1001,11 @@ const folderFilterForKey = (view: SheetViewMode, folderKey: string): string => {
if (key === folderContext.rootPath) {
return `folder == ""`;
}
- const folder = getFoldersForWorksheet(view, key).join("/");
+ const folder = getFoldersForSavedQuery(view, key).join("/");
return `folder == "${escapeCELStringLiteral(folder)}"`;
};
-const worksheetSearchFilters = (): string[] => {
+const savedQuerySearchFilters = (): string[] => {
const filter = useSheetContextStore.getState().filter;
const filters: string[] = [];
const keyword = filter.keyword.trim().toLowerCase();
@@ -1019,44 +1029,44 @@ const sheetFilterForView = (
? [`creator == "users/${escapeCELStringLiteral(email)}"`]
: [
`creator != "users/${escapeCELStringLiteral(email)}"`,
- `visibility in ["${Worksheet_Visibility[Worksheet_Visibility.PROJECT_READ]}","${Worksheet_Visibility[Worksheet_Visibility.PROJECT_WRITE]}"]`,
+ `visibility in ["${SavedQuery_Visibility[SavedQuery_Visibility.PROJECT_READ]}","${SavedQuery_Visibility[SavedQuery_Visibility.PROJECT_WRITE]}"]`,
];
return [
...baseFilters,
...extraFilters,
- ...(includeDisplayFilters ? worksheetSearchFilters() : []),
+ ...(includeDisplayFilters ? savedQuerySearchFilters() : []),
].join(" && ");
};
-const fetchWorksheetsPage = async (
+const fetchSavedQueriesPage = async (
view: SheetViewMode,
pageToken: string,
extraFilters: string[] = []
-): Promise<{ worksheets: Worksheet[]; nextPageToken: string }> => {
+): Promise<{ savedQueries: SavedQuery[]; nextPageToken: string }> => {
if (view !== "my" && view !== "shared") {
- return { worksheets: [], nextPageToken: "" };
+ return { savedQueries: [], nextPageToken: "" };
}
const sheetStore = useAppStore.getState();
const project = getSQLEditorEditorState().project;
const filter = sheetFilterForView(view, extraFilters);
- return sheetStore.fetchWorksheetList(project, filter, {
+ return sheetStore.fetchSavedQueryList(project, filter, {
pageSize: getDefaultPagination(),
pageToken,
});
};
-const fetchWorksheetFoldersForView = async (view: SheetViewMode) => {
+const fetchSavedQueryFoldersForView = async (view: SheetViewMode) => {
if (view !== "my" && view !== "shared") {
return;
}
const project = getSQLEditorEditorState().project;
- const paths = await useAppStore.getState().listWorksheetFolders(project);
+ const paths = await useAppStore.getState().listSavedQueryFolders(project);
const folderPaths = new Set<string>();
for (const { folders, category } of paths) {
if (category !== view) {
continue;
}
- for (const path of getPathesForWorksheet(view, { folders })) {
+ for (const path of getPathesForSavedQuery(view, { folders })) {
folderPaths.add(path);
}
}
@@ -1066,7 +1076,7 @@ const fetchWorksheetFoldersForView = async (view: SheetViewMode) => {
getFolderContext(view).replaceFolders(folderPaths);
};
-const fetchWorksheetsByFolder = async (
+const fetchSavedQueriesByFolder = async (
view: SheetViewMode,
folderKey: string
) => {
@@ -1088,23 +1098,25 @@ const fetchWorksheetsByFolder = async (
return;
}
- const folder = getFoldersForWorksheet(view, key).join("/");
+ const folder = getFoldersForSavedQuery(view, key).join("/");
if (!folder) {
return;
}
state.setViewFolderFetching(view, key, true);
try {
- const { worksheets, nextPageToken } = await fetchWorksheetsPage(view, "", [
- `folder == "${escapeCELStringLiteral(folder)}"`,
- ]);
+ const { savedQueries, nextPageToken } = await fetchSavedQueriesPage(
+ view,
+ "",
+ [`folder == "${escapeCELStringLiteral(folder)}"`]
+ );
const names = new Set(
- useSheetContextStore.getState().viewStates[view].worksheetNames
+ useSheetContextStore.getState().viewStates[view].savedQueryNames
);
- for (const worksheet of worksheets) {
- names.add(worksheet.name);
+ for (const savedQuery of savedQueries) {
+ names.add(savedQuery.name);
}
- useSheetContextStore.getState().setViewWorksheetNames(view, [...names]);
+ useSheetContextStore.getState().setViewSavedQueryNames(view, [...names]);
useSheetContextStore
.getState()
.setViewFolderNextPageToken(view, key, nextPageToken);
@@ -1141,7 +1153,7 @@ const buildViewContext = (view: SheetViewMode): ViewContext => {
return useSheetContextStore.getState().viewStates[view].sheetTree;
},
get folderTree() {
- const root: WorksheetFolderNode = {
+ const root: SavedQueryFolderNode = {
...rootTreeNodeFor(view),
key: folderContext.rootPath,
};
@@ -1151,13 +1163,13 @@ const buildViewContext = (view: SheetViewMode): ViewContext => {
events: getEvents(view),
fetchSheetList: () => fetchSheetListFor(view),
fetchNextPage: (folderKey) => fetchNextSheetPageFor(view, folderKey),
- fetchWorksheetsByFolder: (folderKey) =>
- fetchWorksheetsByFolder(view, folderKey),
+ fetchSavedQueriesByFolder: (folderKey) =>
+ fetchSavedQueriesByFolder(view, folderKey),
rebuildTree: () => getRebuildTreeFn(view)(),
- getKeyForWorksheet: (ws) => getKeyForWorksheet(view, ws),
- getFoldersForWorksheet: (path) => getFoldersForWorksheet(view, path),
- getPathesForWorksheet: (ws) => getPathesForWorksheet(view, ws),
- getPwdForWorksheet: (ws) => getPwdForWorksheet(view, ws),
+ getKeyForSavedQuery: (ws) => getKeyForSavedQuery(view, ws),
+ getFoldersForSavedQuery: (path) => getFoldersForSavedQuery(view, path),
+ getPathesForSavedQuery: (ws) => getPathesForSavedQuery(view, ws),
+ getPwdForSavedQuery: (ws) => getPwdForSavedQuery(view, ws),
};
};
@@ -1172,53 +1184,55 @@ const getViewContext = (view: SheetViewMode): ViewContext => {
// ---- side effects (initialized lazily on first use) ------------------------
-const isWorksheetCreator = (worksheet: { creator: string }) => {
+const isSavedQueryCreator = (savedQuery: { creator: string }) => {
const email = useAppStore.getState().currentUser?.email;
if (!email) return false;
- return worksheet.creator === `users/${email}`;
+ return savedQuery.creator === `users/${email}`;
};
-const viewForWorksheet = (worksheet: Worksheet): SheetViewMode | undefined => {
+const viewForSavedQuery = (
+ savedQuery: SavedQuery
+): SheetViewMode | undefined => {
const project = getSQLEditorEditorState().project;
- if (worksheet.project !== project) return undefined;
- if (isWorksheetCreator(worksheet)) return "my";
+ if (savedQuery.project !== project) return undefined;
+ if (isSavedQueryCreator(savedQuery)) return "my";
if (
- worksheet.visibility === Worksheet_Visibility.PROJECT_READ ||
- worksheet.visibility === Worksheet_Visibility.PROJECT_WRITE
+ savedQuery.visibility === SavedQuery_Visibility.PROJECT_READ ||
+ savedQuery.visibility === SavedQuery_Visibility.PROJECT_WRITE
) {
return "shared";
}
return undefined;
};
-const addNewWorksheetsToViewMembership = (
- worksheetsByKey: Record<string, Worksheet>,
- prevWorksheetsByKey: Record<string, Worksheet>
+const addNewSavedQueriesToViewMembership = (
+ savedQueriesByKey: Record<string, SavedQuery>,
+ prevSavedQueriesByKey: Record<string, SavedQuery>
) => {
const prevNames = new Set(
- Object.values(prevWorksheetsByKey).map((worksheet) => worksheet.name)
+ Object.values(prevSavedQueriesByKey).map((savedQuery) => savedQuery.name)
);
- for (const worksheet of Object.values(worksheetsByKey)) {
- if (prevNames.has(worksheet.name)) continue;
- const view = viewForWorksheet(worksheet);
+ for (const savedQuery of Object.values(savedQueriesByKey)) {
+ if (prevNames.has(savedQuery.name)) continue;
+ const view = viewForSavedQuery(savedQuery);
if (!view) continue;
const state = useSheetContextStore.getState();
const viewState = state.viewStates[view];
if (
!viewState.isInitialized ||
- viewState.worksheetNames.includes(worksheet.name)
+ viewState.savedQueryNames.includes(savedQuery.name)
) {
continue;
}
- state.setViewWorksheetNames(view, [
- ...viewState.worksheetNames,
- worksheet.name,
+ state.setViewSavedQueryNames(view, [
+ ...viewState.savedQueryNames,
+ savedQuery.name,
]);
}
};
-const batchUpdateWorksheetFolders = async (
- worksheets: { name: string; folders: string[] }[]
+const batchUpdateSavedQueryFolders = async (
+ savedQueries: { name: string; folders: string[] }[]
): Promise<void> => {
const affectedFolderKeysByView = new Map<SheetViewMode, Set<string>>();
const addAffectedFolderKey = (view: SheetViewMode, folderKey: string) => {
@@ -1231,34 +1245,34 @@ const batchUpdateWorksheetFolders = async (
string,
{ parent: string; folders: string[]; names: string[] }
>();
- for (const worksheet of worksheets) {
- const current = useAppStore.getState().getWorksheetByName(worksheet.name);
- const view = current ? viewForWorksheet(current) : undefined;
+ for (const savedQuery of savedQueries) {
+ const current = useAppStore.getState().getSavedQueryByName(savedQuery.name);
+ const view = current ? viewForSavedQuery(current) : undefined;
if (current && (view === "my" || view === "shared")) {
- addAffectedFolderKey(view, getPwdForWorksheet(view, current));
- addAffectedFolderKey(view, getPwdForWorksheet(view, worksheet));
+ addAffectedFolderKey(view, getPwdForSavedQuery(view, current));
+ addAffectedFolderKey(view, getPwdForSavedQuery(view, savedQuery));
}
- const index = worksheet.name.lastIndexOf("/worksheets/");
+ const index = savedQuery.name.lastIndexOf("/savedQueries/");
if (index < 0) {
continue;
}
- const parent = worksheet.name.slice(0, index);
- const key = JSON.stringify([parent, worksheet.folders]);
+ const parent = savedQuery.name.slice(0, index);
+ const key = JSON.stringify([parent, savedQuery.folders]);
const request = requestByKey.get(key);
if (request) {
- request.names.push(worksheet.name);
+ request.names.push(savedQuery.name);
} else {
requestByKey.set(key, {
parent,
- folders: worksheet.folders,
- names: [worksheet.name],
+ folders: savedQuery.folders,
+ names: [savedQuery.name],
});
}
}
const requests = [...requestByKey.values()];
if (requests.length === 0) return;
- await useAppStore.getState().batchUpdateWorksheetOrganizers(
+ await useAppStore.getState().batchUpdateSavedQueryOrganizers(
requests.map((request) => ({
parent: request.parent,
filter: `name in [${request.names
@@ -1276,9 +1290,9 @@ const batchUpdateWorksheetFolders = async (
}
};
-const batchUpdateWorksheetFolderPaths = async (
+const batchUpdateSavedQueryFolderPaths = async (
view: SheetViewMode,
- updates: WorksheetFolderPathUpdate[]
+ updates: SavedQueryFolderPathUpdate[]
): Promise<void> => {
if (view !== "my" && view !== "shared") return;
if (updates.length === 0) return;
@@ -1286,7 +1300,7 @@ const batchUpdateWorksheetFolderPaths = async (
const sortedUpdates = [...updates].sort(
(a, b) => b.sourceFolder.length - a.sourceFolder.length
);
- await useAppStore.getState().batchUpdateWorksheetOrganizers(
+ await useAppStore.getState().batchUpdateSavedQueryOrganizers(
sortedUpdates.map((update) => ({
parent: project,
filter: sheetFilterForView(
@@ -1310,7 +1324,7 @@ let _lastTabKey = "";
let _lastDraftSig = "";
// Signature of the draft view's source data — the open tabs that have
-// no worksheet, keyed by id + title. The "draft" tree derives from
+// no saved query, keyed by id + title. The "draft" tree derives from
// these (see `sheetLikeItemsForView`), so the tree must rebuild when a
// draft tab is opened, closed, or renamed.
const computeDraftSignature = (
@@ -1319,7 +1333,7 @@ const computeDraftSignature = (
tabsState.openTmpTabList
.map((persisted) => {
const tab = tabsState.tabsById.get(persisted.id);
- if (!tab || tab.worksheet) return "";
+ if (!tab || tab.savedQuery) return "";
return `${tab.id}:${tab.title}`;
})
.filter((s) => s)
@@ -1362,7 +1376,7 @@ const bindWatchers = () => {
// move folder). Mirrors the Vue `watch(folderContext.folders,
// rebuildTree)`. Debounced + idempotent `mergeFolders` inside the
// rebuild keeps this from looping: the rebuild only writes folders
- // back when a worksheet introduces a brand-new path, which settles
+ // back when a saved query introduces a brand-new path, which settles
// after one extra pass.
for (const view of SheetViewModeList) {
if (state.viewStates[view].folders !== prev.viewStates[view].folders) {
@@ -1374,7 +1388,7 @@ const bindWatchers = () => {
subscribeSQLEditorTabsState((tabsState) => {
// Current-tab change → update tree selection + scroll-into-view.
const tab = tabsState.tabsById.get(tabsState.currentTabId);
- const tabKey = `${tab?.id ?? ""}|${tab?.worksheet ?? ""}`;
+ const tabKey = `${tab?.id ?? ""}|${tab?.savedQuery ?? ""}`;
if (tabKey !== _lastTabKey) {
_lastTabKey = tabKey;
onCurrentTabChanged(tab);
@@ -1382,7 +1396,7 @@ const bindWatchers = () => {
// Draft-tab set / title change → rebuild the draft tree. The draft
// view's `sheetLikeItemList` is derived from open tabs without a
- // worksheet, so adding / closing / renaming a draft must refresh it.
+ // saved query, so adding / closing / renaming a draft must refresh it.
// Mirrors the Vue `watch(sheetLikeItemList, rebuildTree)` for the
// draft view context.
const draftSig = computeDraftSignature(tabsState);
@@ -1392,18 +1406,18 @@ const bindWatchers = () => {
}
});
- // Rebuild the worksheet-backed trees whenever the worksheet cache
+ // Rebuild the saved query-backed trees whenever the saved query cache
// mutates — a fetch, a title patch (e.g. renamed from the editor tab),
// a star toggle, or a delete. Mirrors the Vue
// `watch(sheetLikeItemList, rebuildTree)` that drove the tree off the
- // worksheet list. The "draft" view is tab-derived, not worksheet-
+ // saved query list. The "draft" view is tab-derived, not saved query-
// derived, so it doesn't need this. Debounced rebuilds coalesce the
// burst of cache writes a single fetch produces.
useAppStore.subscribe((state, prev) => {
- if (state.worksheetsByKey === prev.worksheetsByKey) return;
- addNewWorksheetsToViewMembership(
- state.worksheetsByKey,
- prev.worksheetsByKey
+ if (state.savedQueriesByKey === prev.savedQueriesByKey) return;
+ addNewSavedQueriesToViewMembership(
+ state.savedQueriesByKey,
+ prev.savedQueriesByKey
);
getRebuildTreeFn("my")();
getRebuildTreeFn("shared")();
@@ -1428,22 +1442,24 @@ const onCurrentTabChanged = (tab: SQLEditorTab | undefined) => {
if (!tab) return;
let view: SheetViewMode = "draft";
- let worksheetLikeItem: WorksheetLikeItem | undefined;
+ let savedQueryLikeItem: SavedQueryLikeItem | undefined;
const tabId = tab.id;
- const worksheetName = tab.worksheet;
-
- if (worksheetName) {
- const worksheet = useAppStore.getState().getWorksheetByName(worksheetName);
- if (!worksheet) return;
- worksheetLikeItem = {
- name: worksheet.name,
- title: worksheet.title,
- folders: worksheet.folders,
- type: "worksheet",
+ const savedQueryName = tab.savedQuery;
+
+ if (savedQueryName) {
+ const savedQuery = useAppStore
+ .getState()
+ .getSavedQueryByName(savedQueryName);
+ if (!savedQuery) return;
+ savedQueryLikeItem = {
+ name: savedQuery.name,
+ title: savedQuery.title,
+ folders: savedQuery.folders,
+ type: "savedQuery",
};
- view = isWorksheetCreator(worksheet) ? "my" : "shared";
+ view = isSavedQueryCreator(savedQuery) ? "my" : "shared";
} else {
- worksheetLikeItem = {
+ savedQueryLikeItem = {
name: tabId,
folders: [],
title: "",
@@ -1452,11 +1468,11 @@ const onCurrentTabChanged = (tab: SQLEditorTab | undefined) => {
}
const viewCtx = getViewContext(view);
- const key = viewCtx.getKeyForWorksheet(worksheetLikeItem);
+ const key = viewCtx.getKeyForSavedQuery(savedQueryLikeItem);
useSheetContextStore.getState().setSelectedKeys([key]);
const expanded = new Set(useSheetContextStore.getState().expandedKeys);
- for (const path of viewCtx.getPathesForWorksheet(worksheetLikeItem)) {
+ for (const path of viewCtx.getPathesForSavedQuery(savedQueryLikeItem)) {
expanded.add(path);
}
useSheetContextStore.getState().setExpandedKeys(expanded);
@@ -1476,20 +1492,20 @@ const onCurrentTabChanged = (tab: SQLEditorTab | undefined) => {
// ---- public hook API -------------------------------------------------------
export interface SheetContext {
- filter: WorksheetFilter;
+ filter: SavedQueryFilter;
filterChanged: boolean;
expandedKeys: Set<string>;
selectedKeys: string[];
- editingNode: { node: WorksheetFolderNode; rawLabel: string } | undefined;
+ editingNode: { node: SavedQueryFolderNode; rawLabel: string } | undefined;
view: SheetViewMode;
viewContexts: Record<SheetViewMode, ViewContext>;
- isWorksheetCreator: (worksheet: { creator: string }) => boolean;
- batchUpdateWorksheetFolders: (
- worksheets: { name: string; folders: string[] }[]
+ isSavedQueryCreator: (savedQuery: { creator: string }) => boolean;
+ batchUpdateSavedQueryFolders: (
+ savedQueries: { name: string; folders: string[] }[]
) => Promise<void>;
- batchUpdateWorksheetFolderPaths: (
+ batchUpdateSavedQueryFolderPaths: (
view: SheetViewMode,
- updates: WorksheetFolderPathUpdate[]
+ updates: SavedQueryFolderPathUpdate[]
) => Promise<void>;
getContextByView: (view: SheetViewMode) => ViewContext;
setFilter: SheetContextState["setFilter"];
@@ -1551,9 +1567,9 @@ export function useSheetContext(): SheetContext {
return {
...reactive,
viewContexts: VIEW_CONTEXTS_LAZY,
- isWorksheetCreator,
- batchUpdateWorksheetFolders,
- batchUpdateWorksheetFolderPaths,
+ isSavedQueryCreator,
+ batchUpdateSavedQueryFolders,
+ batchUpdateSavedQueryFolderPaths,
getContextByView: getViewContext,
setFilter: setFilterAction,
setView: setViewAction,
@@ -1595,8 +1611,8 @@ export const KEY = Symbol("bb.sql-editor.sheet");
// ---- tree helpers (unchanged) ----------------------------------------------
export const revealNodes = <T>(
- node: WorksheetFolderNode,
- callback: (node: WorksheetFolderNode) => T | undefined
+ node: SavedQueryFolderNode,
+ callback: (node: SavedQueryFolderNode) => T | undefined
): T[] => {
const results: T[] = [];
const item = callback(node);
@@ -1609,33 +1625,33 @@ export const revealNodes = <T>(
return results;
};
-export const revealWorksheets = <T>(
- node: WorksheetFolderNode,
- callback: (node: WorksheetFolderNode) => T | undefined
+export const revealSavedQueries = <T>(
+ node: SavedQueryFolderNode,
+ callback: (node: SavedQueryFolderNode) => T | undefined
): T[] => {
return revealNodes(node, (n) => {
- if (!n.worksheet) return undefined;
+ if (!n.savedQuery) return undefined;
return callback(n);
});
};
-// ---- openWorksheetByName (unchanged behavior) ------------------------------
+// ---- openSavedQueryByName (unchanged behavior) ------------------------------
-export const openWorksheetByName = async ({
- worksheet,
+export const openSavedQueryByName = async ({
+ savedQuery,
forceNewTab,
mode,
}: {
- worksheet: string;
+ savedQuery: string;
forceNewTab: boolean;
mode?: SQLEditorTabMode;
}) => {
const sheet = await useAppStore
.getState()
- .getOrFetchWorksheetByName(worksheet);
+ .getOrFetchSavedQueryByName(savedQuery);
if (!sheet) return undefined;
- if (!isWorksheetReadableV1(sheet)) {
+ if (!isSavedQueryReadableV1(sheet)) {
useAppStore.getState().notify({
module: "bytebase",
style: "CRITICAL",
@@ -1648,7 +1664,7 @@ export const openWorksheetByName = async ({
const openingSheetTab = (() => {
for (const persisted of tabsState.openTmpTabList) {
const tab = tabsState.tabsById.get(persisted.id);
- if (tab?.worksheet === sheet.name) return tab;
+ if (tab?.savedQuery === sheet.name) return tab;
}
return undefined;
})();
@@ -1662,14 +1678,14 @@ export const openWorksheetByName = async ({
}
const statement = getSheetStatement(sheet);
- const connection = await extractWorksheetConnection(sheet);
+ const connection = await extractSavedQueryConnection(sheet);
const newTab: Partial<SQLEditorTab> = {
connection,
- worksheet: sheet.name,
+ savedQuery: sheet.name,
title: sheet.title,
statement,
status: "CLEAN",
- mode: mode ?? "WORKSHEET",
+ mode: mode ?? "SAVED_QUERY",
};
return tabsState.addTab(newTab, forceNewTab /* beside */);
diff --git a/frontend/src/modules/sql-editor/model/Sheet/folder.ts b/frontend/src/modules/sql-editor/model/Sheet/folder.ts
index e9873cc44c..9894680344 100644
--- a/frontend/src/modules/sql-editor/model/Sheet/folder.ts
+++ b/frontend/src/modules/sql-editor/model/Sheet/folder.ts
@@ -1,4 +1,4 @@
-// Pure worksheet-folder path helpers, extracted from context.ts so the
+// Pure saved query-folder path helpers, extracted from context.ts so the
// hierarchy logic is directly unit-testable.
/**
diff --git a/frontend/src/modules/sql-editor/model/events.ts b/frontend/src/modules/sql-editor/model/events.ts
index 7abad2c7b5..301897ca37 100644
--- a/frontend/src/modules/sql-editor/model/events.ts
+++ b/frontend/src/modules/sql-editor/model/events.ts
@@ -21,7 +21,7 @@ export type SQLEditorEvents = {
"append-editor-content": { content: string; select: boolean };
"insert-at-caret": { content: string };
// Fired after a SQL statement has finished executing — by both the
- // worksheet (`useExecuteSQL`) and admin/terminal (`webTerminal`)
+ // saved query (`useExecuteSQL`) and admin/terminal (`webTerminal`)
// paths. `HistoryPane` listens and refetches. Bypasses store
// reactivity that doesn't reliably propagate the post-exec
// mutations into React selector subscribers.
diff --git a/frontend/src/modules/sql-editor/store/index.ts b/frontend/src/modules/sql-editor/store/index.ts
index c566d213e8..9759d7fef2 100644
--- a/frontend/src/modules/sql-editor/store/index.ts
+++ b/frontend/src/modules/sql-editor/store/index.ts
@@ -4,7 +4,7 @@ import { createTreeSlice } from "./tree";
import type { SQLEditorStoreState } from "./types";
import { createUIStateSlice } from "./uiState";
import { createWebTerminalSlice } from "./webTerminal";
-import { createWorksheetSaveSlice } from "./worksheet";
+import { createSavedQuerySaveSlice } from "./savedQuery";
export type {
AsidePanelTab,
@@ -25,5 +25,5 @@ export const useSQLEditorStore = create<SQLEditorStoreState>()((...args) => ({
...createQueryHistorySlice(...args),
...createTreeSlice(...args),
...createWebTerminalSlice(...args),
- ...createWorksheetSaveSlice(...args),
+ ...createSavedQuerySaveSlice(...args),
}));
diff --git a/frontend/src/modules/sql-editor/store/queryHistory.test.ts b/frontend/src/modules/sql-editor/store/queryHistory.test.ts
index 8bee484c90..f219910851 100644
--- a/frontend/src/modules/sql-editor/store/queryHistory.test.ts
+++ b/frontend/src/modules/sql-editor/store/queryHistory.test.ts
@@ -7,11 +7,11 @@ import {
} from "./queryHistory";
import type {
QueryHistoryFilter,
+ SavedQuerySaveSlice,
SQLEditorStoreState,
TreeSlice,
UIStateSlice,
WebTerminalSlice,
- WorksheetSaveSlice,
} from "./types";
const searchQueryHistoriesMock = vi.fn();
@@ -29,7 +29,7 @@ vi.mock("@/api", () => ({
// `SQLEditorStoreState` shape without dragging in the real uiState
// slice (which reads localStorage on creation).
const stubUIStateSlice = (): UIStateSlice => ({
- asidePanelTab: "WORKSHEET",
+ asidePanelTab: "SAVED_QUERY",
showConnectionPanel: false,
showAIPanel: false,
pendingInsertAtCaret: undefined,
@@ -66,13 +66,13 @@ const stubWebTerminalSlice = (): WebTerminalSlice => ({
updateWebTerminalQueryItem: vi.fn(),
});
-const stubWorksheetSaveSlice = (): WorksheetSaveSlice => ({
+const stubSavedQuerySaveSlice = (): SavedQuerySaveSlice => ({
autoSaveController: null,
setAutoSaveController: vi.fn(),
abortAutoSave: vi.fn(),
maybeSwitchProject: vi.fn(async () => undefined),
- maybeUpdateWorksheet: vi.fn(async () => undefined),
- createWorksheet: vi.fn(async () => undefined),
+ maybeUpdateSavedQuery: vi.fn(async () => undefined),
+ createSavedQuery: vi.fn(async () => undefined),
});
const makeStore = (): StoreApi<SQLEditorStoreState> =>
@@ -80,7 +80,7 @@ const makeStore = (): StoreApi<SQLEditorStoreState> =>
...stubUIStateSlice(),
...stubTreeSlice(),
...stubWebTerminalSlice(),
- ...stubWorksheetSaveSlice(),
+ ...stubSavedQuerySaveSlice(),
...createQueryHistorySlice(...args),
}));
diff --git a/frontend/src/modules/sql-editor/store/worksheet.test.ts b/frontend/src/modules/sql-editor/store/savedQuery.test.ts
similarity index 83%
rename from frontend/src/modules/sql-editor/store/worksheet.test.ts
rename to frontend/src/modules/sql-editor/store/savedQuery.test.ts
index cc9d50ab13..262ba9b531 100644
--- a/frontend/src/modules/sql-editor/store/worksheet.test.ts
+++ b/frontend/src/modules/sql-editor/store/savedQuery.test.ts
@@ -1,6 +1,7 @@
import { beforeEach, describe, expect, test, vi } from "vitest";
import { create, type StoreApi } from "zustand";
import { getSQLEditorEditorState } from "./editor";
+import { createSavedQuerySaveSlice } from "./savedQuery";
import { getSQLEditorTabsState } from "./tab";
import type {
QueryHistorySlice,
@@ -9,14 +10,13 @@ import type {
UIStateSlice,
WebTerminalSlice,
} from "./types";
-import { createWorksheetSaveSlice } from "./worksheet";
// Stub all the other slices so the composed store satisfies
// `SQLEditorStoreState` without dragging in real implementations
-// (the worksheet slice itself dynamic-imports the Pinia stores it
+// (the saved query slice itself dynamic-imports the Pinia stores it
// needs, so we only have to mock those via vi.mock below).
const stubUIStateSlice = (): UIStateSlice => ({
- asidePanelTab: "WORKSHEET",
+ asidePanelTab: "SAVED_QUERY",
showConnectionPanel: false,
showAIPanel: false,
pendingInsertAtCaret: undefined,
@@ -76,11 +76,11 @@ const piniaMocks = vi.hoisted(() => ({
tabStore: {
updateTab: vi.fn(),
},
- worksheetStore: {
- getWorksheetByName: vi.fn(),
- patchWorksheet: vi.fn(),
- upsertWorksheetOrganizer: vi.fn(),
- createWorksheet: vi.fn(),
+ savedQueryStore: {
+ getSavedQueryByName: vi.fn(),
+ patchSavedQuery: vi.fn(),
+ upsertSavedQueryOrganizer: vi.fn(),
+ createSavedQuery: vi.fn(),
fetchProject: vi.fn(),
loadProjectIamPolicy: vi.fn(),
},
@@ -91,7 +91,7 @@ vi.mock("@/stores", () => ({
}));
vi.mock("@/stores/app", () => ({
- useAppStore: { getState: () => piniaMocks.worksheetStore },
+ useAppStore: { getState: () => piniaMocks.savedQueryStore },
}));
vi.mock("@/modules/sql-editor/store/tab-vue-state", () => ({
@@ -111,11 +111,11 @@ vi.mock("@/modules/sql-editor/model/events", () => ({
}));
vi.mock("@/modules/sql-editor/model/Sheet", () => ({
- openWorksheetByName: vi.fn(),
+ openSavedQueryByName: vi.fn(),
}));
vi.mock("@/lib/sqlEditorConnection", () => ({
- extractWorksheetConnection: vi.fn(
+ extractSavedQueryConnection: vi.fn(
async ({ database }: { database: string }) => ({
instance: database ? "instances/cosmos" : "",
database,
@@ -129,7 +129,7 @@ const makeStore = (): StoreApi<SQLEditorStoreState> =>
...stubQueryHistorySlice(),
...stubTreeSlice(),
...stubWebTerminalSlice(),
- ...createWorksheetSaveSlice(...args),
+ ...createSavedQuerySaveSlice(...args),
}));
beforeEach(() => {
@@ -146,7 +146,7 @@ beforeEach(() => {
getSQLEditorTabsState().reset();
});
-describe("worksheet save slice — autoSaveController", () => {
+describe("saved query save slice — autoSaveController", () => {
test("initial value is null", () => {
const store = makeStore();
expect(store.getState().autoSaveController).toBeNull();
@@ -176,11 +176,11 @@ describe("worksheet save slice — autoSaveController", () => {
});
});
-describe("worksheet save slice — maybeUpdateWorksheet", () => {
- test("preserves the selected Cosmos DB container when saving the worksheet", async () => {
+describe("saved query save slice — maybeUpdateSavedQuery", () => {
+ test("preserves the selected Cosmos DB container when saving the saved query", async () => {
const store = makeStore();
const tab = getSQLEditorTabsState().addTab({
- worksheet: "projects/default/worksheets/cosmos-sheet",
+ savedQuery: "projects/default/savedQueries/cosmos-sheet",
connection: {
instance: "instances/cosmos",
database: "instances/cosmos/databases/grs",
@@ -189,18 +189,18 @@ describe("worksheet save slice — maybeUpdateWorksheet", () => {
statement: "select * from SUPPORDERS_VIS.items",
status: "DIRTY",
});
- piniaMocks.worksheetStore.getWorksheetByName.mockReturnValue({
- name: tab.worksheet,
- title: "Cosmos worksheet",
+ piniaMocks.savedQueryStore.getSavedQueryByName.mockReturnValue({
+ name: tab.savedQuery,
+ title: "Cosmos saved query",
database: tab.connection.database,
});
- piniaMocks.worksheetStore.patchWorksheet.mockResolvedValue({
- name: tab.worksheet,
+ piniaMocks.savedQueryStore.patchSavedQuery.mockResolvedValue({
+ name: tab.savedQuery,
});
- await store.getState().maybeUpdateWorksheet({
+ await store.getState().maybeUpdateSavedQuery({
tabId: tab.id,
- worksheet: tab.worksheet,
+ savedQuery: tab.savedQuery,
database: tab.connection.database,
statement: tab.statement,
});
@@ -213,7 +213,7 @@ describe("worksheet save slice — maybeUpdateWorksheet", () => {
});
});
-describe("worksheet save slice — maybeSwitchProject", () => {
+describe("saved query save slice — maybeSwitchProject", () => {
test("with an invalid project name returns undefined without setting project", async () => {
const store = makeStore();
const result = await store.getState().maybeSwitchProject("not-a-project");
@@ -222,10 +222,10 @@ describe("worksheet save slice — maybeSwitchProject", () => {
});
test("switches project even when project IAM policy preload fails", async () => {
- piniaMocks.worksheetStore.fetchProject.mockResolvedValue({
+ piniaMocks.savedQueryStore.fetchProject.mockResolvedValue({
name: "projects/aaa",
});
- piniaMocks.worksheetStore.loadProjectIamPolicy.mockRejectedValue(
+ piniaMocks.savedQueryStore.loadProjectIamPolicy.mockRejectedValue(
new Error("permission denied")
);
diff --git a/frontend/src/modules/sql-editor/store/worksheet.ts b/frontend/src/modules/sql-editor/store/savedQuery.ts
similarity index 67%
rename from frontend/src/modules/sql-editor/store/worksheet.ts
rename to frontend/src/modules/sql-editor/store/savedQuery.ts
index 363dc35710..e7b733fdd8 100644
--- a/frontend/src/modules/sql-editor/store/worksheet.ts
+++ b/frontend/src/modules/sql-editor/store/savedQuery.ts
@@ -1,21 +1,20 @@
import { create } from "@bufbuild/protobuf";
import { isUndefined } from "lodash-es";
-import { extractWorksheetConnection } from "@/lib/sqlEditorConnection";
+import { extractSavedQueryConnection } from "@/lib/sqlEditorConnection";
import { sqlEditorEvents } from "@/modules/sql-editor/model/events";
-import { openWorksheetByName } from "@/modules/sql-editor/model/Sheet";
+import { openSavedQueryByName } from "@/modules/sql-editor/model/Sheet";
import { useAppStore } from "@/stores/app";
import { isValidProjectName } from "@/types";
import {
- type Worksheet,
- Worksheet_Visibility,
- WorksheetSchema,
-} from "@/types/proto-es/v1/worksheet_service_pb";
+ SavedQuery_Visibility,
+ SavedQuerySchema,
+} from "@/types/proto-es/v1/saved_query_service_pb";
import { getSQLEditorEditorState } from "./editor";
import { getSQLEditorTabsState } from "./tab";
-import type { SQLEditorSliceCreator, WorksheetSaveSlice } from "./types";
+import type { SavedQuerySaveSlice, SQLEditorSliceCreator } from "./types";
-export const createWorksheetSaveSlice: SQLEditorSliceCreator<
- WorksheetSaveSlice
+export const createSavedQuerySaveSlice: SQLEditorSliceCreator<
+ SavedQuerySaveSlice
> = (set, get) => ({
autoSaveController: null,
@@ -62,9 +61,9 @@ export const createWorksheetSaveSlice: SQLEditorSliceCreator<
}
},
- maybeUpdateWorksheet: async ({
+ maybeUpdateSavedQuery: async ({
tabId,
- worksheet,
+ savedQuery,
title,
database,
statement,
@@ -72,13 +71,12 @@ export const createWorksheetSaveSlice: SQLEditorSliceCreator<
signal,
}) => {
const tabStore = getSQLEditorTabsState();
- const worksheetStore = useAppStore.getState();
+ const savedQueryStore = useAppStore.getState();
- const connection = await extractWorksheetConnection({ database });
+ const connection = await extractSavedQueryConnection({ database });
const currentTab = tabStore.tabsById.get(tabId);
const nextConnection =
- currentTab &&
- currentTab.connection.instance === connection.instance &&
+ currentTab?.connection.instance === connection.instance &&
currentTab.connection.database === connection.database
? { ...currentTab.connection, ...connection }
: connection;
@@ -87,19 +85,19 @@ export const createWorksheetSaveSlice: SQLEditorSliceCreator<
// the current title on auto-save calls that never pass one.
// `title === ""` is a real, explicit empty title that should be
// persisted (renders as the Untitled placeholder elsewhere).
- const currentSheet = worksheet
- ? worksheetStore.getWorksheetByName(worksheet)
+ const currentSheet = savedQuery
+ ? savedQueryStore.getSavedQueryByName(savedQuery)
: undefined;
- if (worksheet && !currentSheet) {
+ if (savedQuery && !currentSheet) {
return;
}
- const worksheetTitle = title ?? currentSheet?.title ?? "";
+ const savedQueryTitle = title ?? currentSheet?.title ?? "";
- if (worksheet && currentSheet) {
- const updated = await worksheetStore.patchWorksheet(
+ if (savedQuery && currentSheet) {
+ const updated = await savedQueryStore.patchSavedQuery(
{
...currentSheet,
- title: worksheetTitle,
+ title: savedQueryTitle,
database,
content: new TextEncoder().encode(statement),
},
@@ -110,9 +108,9 @@ export const createWorksheetSaveSlice: SQLEditorSliceCreator<
return;
}
if (!isUndefined(folders)) {
- await worksheetStore.upsertWorksheetOrganizer(
+ await savedQueryStore.upsertSavedQueryOrganizer(
{
- worksheet: updated.name,
+ savedQuery: updated.name,
folders: folders,
},
["folders"]
@@ -123,12 +121,12 @@ export const createWorksheetSaveSlice: SQLEditorSliceCreator<
return tabStore.updateTab(tabId, {
status: "CLEAN",
connection: nextConnection,
- title: worksheetTitle,
- worksheet,
+ title: savedQueryTitle,
+ savedQuery,
});
},
- createWorksheet: async ({
+ createSavedQuery: async ({
tabId,
title,
statement = "",
@@ -137,25 +135,25 @@ export const createWorksheetSaveSlice: SQLEditorSliceCreator<
}) => {
const editorStore = getSQLEditorEditorState();
const tabStore = getSQLEditorTabsState();
- const worksheetStore = useAppStore.getState();
+ const savedQueryStore = useAppStore.getState();
- const worksheetTitle = title ?? "";
- const connection = await extractWorksheetConnection({ database });
+ const savedQueryTitle = title ?? "";
+ const connection = await extractSavedQueryConnection({ database });
- const newWorksheet = await worksheetStore.createWorksheet(
- create(WorksheetSchema, {
- title: worksheetTitle,
+ const newSavedQuery = await savedQueryStore.createSavedQuery(
+ create(SavedQuerySchema, {
+ title: savedQueryTitle,
database,
content: new TextEncoder().encode(statement),
project: editorStore.project,
- visibility: Worksheet_Visibility.PRIVATE,
+ visibility: SavedQuery_Visibility.PRIVATE,
})
);
if (folders.length > 0) {
- await worksheetStore.upsertWorksheetOrganizer(
+ await savedQueryStore.upsertSavedQueryOrganizer(
{
- worksheet: newWorksheet.name,
+ savedQuery: newSavedQuery.name,
folders: folders,
},
["folders"]
@@ -165,15 +163,15 @@ export const createWorksheetSaveSlice: SQLEditorSliceCreator<
if (tabId) {
return tabStore.updateTab(tabId, {
status: "CLEAN",
- title: worksheetTitle,
+ title: savedQueryTitle,
statement,
connection,
- worksheet: newWorksheet.name,
+ savedQuery: newSavedQuery.name,
});
}
- const tab = await openWorksheetByName({
- worksheet: newWorksheet.name,
+ const tab = await openSavedQueryByName({
+ savedQuery: newSavedQuery.name,
forceNewTab: true,
});
queueMicrotask(() => {
@@ -188,6 +186,6 @@ export const createWorksheetSaveSlice: SQLEditorSliceCreator<
},
});
-// Re-export the Worksheet proto type so callers don't have to plumb the
+// Re-export the SavedQuery proto type so callers don't have to plumb the
// proto path themselves.
-export type { Worksheet };
+export type { SavedQuery } from "@/types/proto-es/v1/saved_query_service_pb";
diff --git a/frontend/src/modules/sql-editor/store/tab.test.ts b/frontend/src/modules/sql-editor/store/tab.test.ts
index db5f4ea70c..50e72fe091 100644
--- a/frontend/src/modules/sql-editor/store/tab.test.ts
+++ b/frontend/src/modules/sql-editor/store/tab.test.ts
@@ -9,11 +9,11 @@ import {
const mocks = vi.hoisted(() => ({
loadCurrentUser: vi.fn(async () => undefined),
- getOrFetchWorksheetByName: vi.fn(),
+ getOrFetchSavedQueryByName: vi.fn(),
}));
vi.mock("@/lib/sqlEditorConnection", () => ({
- extractWorksheetConnection: vi.fn(async () => ({
+ extractSavedQueryConnection: vi.fn(async () => ({
instance: "instances/mysql-instance",
database: "instances/mysql-instance/databases/bytebase",
})),
@@ -29,7 +29,7 @@ vi.mock("@/stores/app", () => ({
},
isSaaSMode: () => false,
loadCurrentUser: mocks.loadCurrentUser,
- getOrFetchWorksheetByName: mocks.getOrFetchWorksheetByName,
+ getOrFetchSavedQueryByName: mocks.getOrFetchSavedQueryByName,
}),
},
}));
@@ -69,7 +69,7 @@ beforeEach(() => {
getSQLEditorTabsState().reset();
__resetTabStoreProjectCursor();
mocks.loadCurrentUser.mockClear();
- mocks.getOrFetchWorksheetByName.mockImplementation(async (name: string) => ({
+ mocks.getOrFetchSavedQueryByName.mockImplementation(async (name: string) => ({
name,
project: name.startsWith("projects/project-sample/")
? "projects/project-sample"
@@ -267,19 +267,19 @@ describe("useSQLEditorTabsStore", () => {
unsubscribe();
});
- test("initProject ignores persisted worksheets from other projects", async () => {
+ test("initProject ignores persisted saved queries from other projects", async () => {
storage.set(
storageKeySqlEditorTabs("", "projects/aaa", "[email protected]"),
JSON.stringify([
{
id: "cross-project-tab",
- worksheet: "projects/project-sample/worksheets/sample-sheet",
- mode: "WORKSHEET",
+ savedQuery: "projects/project-sample/savedQueries/sample-sheet",
+ mode: "SAVED_QUERY",
},
{
id: "same-project-tab",
- worksheet: "projects/aaa/worksheets/aaa-sheet",
- mode: "WORKSHEET",
+ savedQuery: "projects/aaa/savedQueries/aaa-sheet",
+ mode: "SAVED_QUERY",
},
])
);
@@ -294,4 +294,34 @@ describe("useSQLEditorTabsStore", () => {
]);
expect(state.currentTabId).toBe("same-project-tab");
});
+
+ test("initProject normalizes tabs persisted before the saved query rename", async () => {
+ // Backstop for storage-migrate's v2 rewrite: a tab stored with the
+ // legacy `worksheet` field, old name format, and "WORKSHEET" mode
+ // must still hydrate into a saved-query-linked tab.
+ storage.set(
+ storageKeySqlEditorTabs("", "projects/aaa", "[email protected]"),
+ JSON.stringify([
+ {
+ id: "legacy-tab",
+ worksheet: "projects/aaa/worksheets/legacy-sheet",
+ mode: "WORKSHEET",
+ },
+ ])
+ );
+
+ await getSQLEditorTabsState().initProject("projects/aaa");
+
+ expect(mocks.getOrFetchSavedQueryByName).toHaveBeenCalledWith(
+ "projects/aaa/savedQueries/legacy-sheet",
+ true
+ );
+ const state = useSQLEditorTabsStore.getState();
+ const tab = state.tabsById.get("legacy-tab");
+ expect(tab?.savedQuery).toBe("projects/aaa/savedQueries/legacy-sheet");
+ expect(tab?.mode).toBe("SAVED_QUERY");
+ expect(
+ state.openTmpTabList.find((t) => t.id === "legacy-tab")
+ ).not.toHaveProperty("worksheet");
+ });
});
diff --git a/frontend/src/modules/sql-editor/store/tab.ts b/frontend/src/modules/sql-editor/store/tab.ts
index 29cdc26180..e2e7764185 100644
--- a/frontend/src/modules/sql-editor/store/tab.ts
+++ b/frontend/src/modules/sql-editor/store/tab.ts
@@ -4,7 +4,7 @@ import { create, type StoreApi, type UseBoundStore } from "zustand";
import { immer } from "zustand/middleware/immer";
import { useShallow } from "zustand/react/shallow";
import {
- extractWorksheetConnection,
+ extractSavedQueryConnection,
isConnectedSQLEditorTab,
} from "@/lib/sqlEditorConnection";
import {
@@ -38,7 +38,7 @@ enableMapSet();
const PERSISTENT_TAB_FIELDS = [
"id",
- "worksheet",
+ "savedQuery",
"mode",
"batchQueryContext",
"treeState",
@@ -121,6 +121,21 @@ const safeWrite = (key: string, value: unknown) => {
const isPersistentTabArray = (v: unknown): v is PersistentTab[] =>
Array.isArray(v);
+// Tabs persisted before the worksheet → saved query rename carry a
+// `worksheet` field holding a `projects/*/worksheets/*` name and mode
+// "WORKSHEET". Rewrite them on read so restored tabs keep their saved
+// query link across the rename.
+const normalizePersistedTab = (
+ persisted: PersistentTab & { worksheet?: string }
+): PersistentTab => {
+ const legacyName = persisted.savedQuery || persisted.worksheet || "";
+ const savedQuery = legacyName.replace("/worksheets/", "/savedQueries/");
+ const mode =
+ (persisted.mode as string) === "WORKSHEET" ? "SAVED_QUERY" : persisted.mode;
+ const { worksheet: _legacy, ...rest } = persisted;
+ return { ...rest, savedQuery, mode };
+};
+
const currentScope = (): {
wsScope: string;
project: string;
@@ -165,7 +180,7 @@ const readOpenTabs = (
): PersistentTab[] =>
safeRead<PersistentTab[]>(
storageKeySqlEditorTabs(wsScope, project, email),
- (v) => (isPersistentTabArray(v) ? v : undefined),
+ (v) => (isPersistentTabArray(v) ? v.map(normalizePersistedTab) : undefined),
[]
);
@@ -431,23 +446,23 @@ const hydrateProjectTabs = async (project: string): Promise<void> => {
for (const persisted of storedTabs) {
if (seen.has(persisted.id)) continue;
- if (!persisted.worksheet) continue;
+ if (!persisted.savedQuery) continue;
- const worksheet = await useAppStore
+ const savedQuery = await useAppStore
.getState()
- .getOrFetchWorksheetByName(persisted.worksheet, true);
- if (!worksheet) continue;
- if (worksheet.project !== project) continue;
+ .getOrFetchSavedQueryByName(persisted.savedQuery, true);
+ if (!savedQuery) continue;
+ if (savedQuery.project !== project) continue;
- const statement = getSheetStatement(worksheet);
- const connection = await extractWorksheetConnection(worksheet);
+ const statement = getSheetStatement(savedQuery);
+ const connection = await extractSavedQueryConnection(savedQuery);
const fullTab: SQLEditorTab = {
...defaultSQLEditorTab(),
...omitBy(persisted, isUndefined),
connection,
- worksheet: worksheet.name,
- title: worksheet.title,
+ savedQuery: savedQuery.name,
+ title: savedQuery.title,
statement,
status: "CLEAN",
databaseQueryContexts: undefined,
@@ -622,7 +637,7 @@ export const useTabById = (tabId: string): SQLEditorTab | undefined =>
export const isSQLEditorTabClosable = (tab: SQLEditorTab): boolean => {
const open = getSQLEditorTabsState().openTmpTabList;
if (open.length > 1) return true;
- if (open.length === 1) return !!tab.worksheet;
+ if (open.length === 1) return !!tab.savedQuery;
return false;
};
diff --git a/frontend/src/modules/sql-editor/store/types.ts b/frontend/src/modules/sql-editor/store/types.ts
index 5d451f0bd8..959238d17d 100644
--- a/frontend/src/modules/sql-editor/store/types.ts
+++ b/frontend/src/modules/sql-editor/store/types.ts
@@ -12,7 +12,7 @@ import type {
SearchQueryHistoriesResponse,
} from "@/types/proto-es/v1/query_history_service_pb";
-export type AsidePanelTab = "SCHEMA" | "WORKSHEET" | "HISTORY" | "ACCESS";
+export type AsidePanelTab = "SCHEMA" | "SAVED_QUERY" | "HISTORY" | "ACCESS";
export interface UIStateSlice {
asidePanelTab: AsidePanelTab;
@@ -107,7 +107,7 @@ export interface WebTerminalSlice {
) => void;
}
-export interface WorksheetSaveSlice {
+export interface SavedQuerySaveSlice {
// Live AbortController for the active auto-save request. Set by the
// auto-save composable so a subsequent edit can cancel the in-flight
// PATCH. `null` between saves.
@@ -115,16 +115,16 @@ export interface WorksheetSaveSlice {
setAutoSaveController: (controller: AbortController | null) => void;
abortAutoSave: () => void;
maybeSwitchProject: (projectName: string) => Promise<string | undefined>;
- maybeUpdateWorksheet: (opts: {
+ maybeUpdateSavedQuery: (opts: {
tabId: string;
- worksheet?: string;
+ savedQuery?: string;
title?: string;
database: string;
statement: string;
folders?: string[];
signal?: AbortSignal;
}) => Promise<SQLEditorTab | undefined>;
- createWorksheet: (opts: {
+ createSavedQuery: (opts: {
tabId?: string;
title?: string;
statement?: string;
@@ -137,7 +137,7 @@ export type SQLEditorStoreState = UIStateSlice &
QueryHistorySlice &
TreeSlice &
WebTerminalSlice &
- WorksheetSaveSlice;
+ SavedQuerySaveSlice;
export type SQLEditorSliceCreator<Slice> = StateCreator<
SQLEditorStoreState,
diff --git a/frontend/src/modules/sql-editor/store/uiState.test.ts b/frontend/src/modules/sql-editor/store/uiState.test.ts
index e33a08eec3..88b9cf14bb 100644
--- a/frontend/src/modules/sql-editor/store/uiState.test.ts
+++ b/frontend/src/modules/sql-editor/store/uiState.test.ts
@@ -3,10 +3,10 @@ import { create, type StoreApi } from "zustand";
import { STORAGE_KEY_SQL_EDITOR_AI_PANEL_SIZE } from "@/utils/storage-keys";
import type {
QueryHistorySlice,
+ SavedQuerySaveSlice,
SQLEditorStoreState,
TreeSlice,
WebTerminalSlice,
- WorksheetSaveSlice,
} from "./types";
const originalLocalStorage = globalThis.localStorage;
@@ -58,13 +58,13 @@ const stubWebTerminalSlice = (): WebTerminalSlice => ({
updateWebTerminalQueryItem: vi.fn(),
});
-const stubWorksheetSaveSlice = (): WorksheetSaveSlice => ({
+const stubSavedQuerySaveSlice = (): SavedQuerySaveSlice => ({
autoSaveController: null,
setAutoSaveController: vi.fn(),
abortAutoSave: vi.fn(),
maybeSwitchProject: vi.fn(async () => undefined),
- maybeUpdateWorksheet: vi.fn(async () => undefined),
- createWorksheet: vi.fn(async () => undefined),
+ maybeUpdateSavedQuery: vi.fn(async () => undefined),
+ createSavedQuery: vi.fn(async () => undefined),
});
// Build a fresh store for each test so the slice's `aiPanelSize`
@@ -81,7 +81,7 @@ const makeStore = async (): Promise<StoreApi<SQLEditorStoreState>> => {
...stubQueryHistorySlice(),
...stubTreeSlice(),
...stubWebTerminalSlice(),
- ...stubWorksheetSaveSlice(),
+ ...stubSavedQuerySaveSlice(),
}));
};
@@ -107,7 +107,7 @@ describe("sqlEditor uiState slice", () => {
test("initial state has documented defaults", async () => {
const useStore = await makeStore();
const s = useStore.getState();
- expect(s.asidePanelTab).toBe("WORKSHEET");
+ expect(s.asidePanelTab).toBe("SAVED_QUERY");
expect(s.showConnectionPanel).toBe(false);
expect(s.showAIPanel).toBe(false);
expect(s.pendingInsertAtCaret).toBeUndefined();
diff --git a/frontend/src/modules/sql-editor/store/uiState.ts b/frontend/src/modules/sql-editor/store/uiState.ts
index 48809bc820..e0f4210751 100644
--- a/frontend/src/modules/sql-editor/store/uiState.ts
+++ b/frontend/src/modules/sql-editor/store/uiState.ts
@@ -31,7 +31,7 @@ const writeAIPanelSize = (size: number) => {
export const createUIStateSlice: SQLEditorSliceCreator<UIStateSlice> = (
set
) => ({
- asidePanelTab: "WORKSHEET",
+ asidePanelTab: "SAVED_QUERY",
showConnectionPanel: false,
showAIPanel: false,
pendingInsertAtCaret: undefined,
diff --git a/frontend/src/routes/workspace/general/sql-editor-theme/ThemePreview.tsx b/frontend/src/routes/workspace/general/sql-editor-theme/ThemePreview.tsx
index 45afc369e2..f8de1d00b7 100644
--- a/frontend/src/routes/workspace/general/sql-editor-theme/ThemePreview.tsx
+++ b/frontend/src/routes/workspace/general/sql-editor-theme/ThemePreview.tsx
@@ -27,7 +27,7 @@ interface ThemePreviewProps {
theme: SQLEditorTheme;
}
-// Illustrative sample DATA (a user's SQL, rows, worksheet/timestamp names) —
+// Illustrative sample DATA (a user's SQL, rows, saved query/timestamp names) —
// representative content, not translatable UI text, so literals are correct
// here. The chrome LABELS (Run/Save/Share/Copy all/rows/etc.) use i18n via `t`.
const PREVIEW_SQL = `SELECT id, name, created_at
@@ -70,7 +70,7 @@ const EMPTY_SEARCH: SearchParams = { query: "", scopes: [] };
/**
* A miniature SQL Editor right-panel rendered with the given theme's tokens:
- * worksheet tabs, the operation toolbar, a real (read-only) Monaco editor, and
+ * saved query tabs, the operation toolbar, a real (read-only) Monaco editor, and
* a result sample. The whole box is wrapped in a single `SQLEditorThemeScope`
* so every descendant re-themes purely through the scope's CSS custom
* properties.
@@ -104,7 +104,7 @@ export function ThemePreview({ theme }: Readonly<ThemePreviewProps>) {
</div>
{/* Inactive tab: bg changes on hover, like the real editor. */}
<div className="flex h-9 items-center gap-x-2 border-r border-t-[3px] border-r-block-border border-t-transparent px-3 text-control-light transition-colors hover:bg-control-bg">
- <span>Worksheet 2</span>
+ <span>SavedQuery 2</span>
<X className="size-3.5" />
</div>
<div className="flex h-9 items-center px-2 text-control-light">
diff --git a/frontend/src/stores/app/index.ts b/frontend/src/stores/app/index.ts
index 48d15bca91..d392d7fc48 100644
--- a/frontend/src/stores/app/index.ts
+++ b/frontend/src/stores/app/index.ts
@@ -27,7 +27,7 @@ import { createServiceAccountSlice } from "./serviceAccount";
import { createSheetSlice } from "./sheet";
import { createSQLSlice } from "./sql";
import { createUserSlice } from "./user";
-import { createWorksheetSlice } from "./worksheet";
+import { createSavedQuerySlice } from "./savedQuery";
import { createWorkspaceSlice } from "./workspace";
import { createWorkloadIdentitySlice } from "./workloadIdentity";
@@ -53,7 +53,7 @@ export const createAppStore = () =>
...createDBGroupSlice(...args),
...createDBSchemaSlice(...args),
...createSheetSlice(...args),
- ...createWorksheetSlice(...args),
+ ...createSavedQuerySlice(...args),
...createInstanceRoleSlice(...args),
...createGroupSlice(...args),
...createServiceAccountSlice(...args),
diff --git a/frontend/src/stores/app/savedQuery.ts b/frontend/src/stores/app/savedQuery.ts
new file mode 100644
index 0000000000..88c7d269cc
--- /dev/null
+++ b/frontend/src/stores/app/savedQuery.ts
@@ -0,0 +1,269 @@
+import { clone, create as createProto } from "@bufbuild/protobuf";
+import { createContextValues } from "@connectrpc/connect";
+import { uniqBy } from "lodash-es";
+import { savedQueryServiceClientConnect } from "@/api";
+import { silentContextKey } from "@/api/context-key";
+import { UNKNOWN_ID } from "@/types";
+import type {
+ SavedQuery,
+ SavedQueryOrganizer,
+} from "@/types/proto-es/v1/saved_query_service_pb";
+import {
+ BatchUpdateSavedQueryOrganizerRequestSchema,
+ CreateSavedQueryRequestSchema,
+ DeleteSavedQueryRequestSchema,
+ GetSavedQueryRequestSchema,
+ ListSavedQueryFoldersRequestSchema,
+ SavedQueryFolder_Category,
+ SavedQueryOrganizerSchema,
+ SavedQuerySchema,
+ SearchSavedQueriesRequestSchema,
+ UpdateSavedQueryOrganizerRequestSchema,
+ UpdateSavedQueryRequestSchema,
+} from "@/types/proto-es/v1/saved_query_service_pb";
+import { isValidDatabaseName } from "@/types/v1/database";
+import { extractSavedQueryID } from "@/utils/v1/savedQuery";
+import type { AppSliceCreator, SavedQuerySlice, SavedQueryView } from "./types";
+
+const cacheKey = (uid: string, view: SavedQueryView) => `${uid}:${view}`;
+
+/**
+ * Zustand port of the legacy Pinia `useWorkSheetStore`. Saved queries are
+ * keyed by `${uid}:${view}` so FULL (with statement) and BASIC (list)
+ * views coexist, matching the old cache. Related resources (project,
+ * database, creator) are hydrated through the sibling app slices rather
+ * than the old Pinia stores.
+ */
+export const createSavedQuerySlice: AppSliceCreator<SavedQuerySlice> = (
+ set,
+ get
+) => {
+ const setCacheEntry = (savedQuery: SavedQuery, view: SavedQueryView) => {
+ const uid = extractSavedQueryID(savedQuery.name);
+ if (uid === String(UNKNOWN_ID)) return;
+ set((s) => {
+ const savedQueriesByKey = { ...s.savedQueriesByKey };
+ // A FULL entry supersedes any stale BASIC entry for the same uid.
+ if (view === "FULL") {
+ delete savedQueriesByKey[cacheKey(uid, "BASIC")];
+ }
+ savedQueriesByKey[cacheKey(uid, view)] = savedQuery;
+ return { savedQueriesByKey };
+ });
+ };
+
+ const hydrateRelatedResources = async (savedQueries: SavedQuery[]) => {
+ // A saved query without a connection has `database: ""`. The batch
+ // endpoint rejects the whole request on an invalid name, which would
+ // drop hydration for every valid database in the same batch, so filter
+ // those out first. Dedupe all three to keep the batch payloads minimal.
+ const databases = [
+ ...new Set(
+ savedQueries.map((w) => w.database).filter(isValidDatabaseName)
+ ),
+ ];
+ try {
+ await Promise.all([
+ get().batchFetchProjects([
+ ...new Set(savedQueries.map((w) => w.project)),
+ ]),
+ get().batchFetchDatabases(databases),
+ get().batchGetOrFetchUsers([
+ ...new Set(savedQueries.map((w) => w.creator)),
+ ]),
+ ]);
+ } catch {
+ // Best-effort hydration; the saved query entry is still cached below.
+ }
+ };
+
+ const updateCacheWithOrganizer = (organizer: SavedQueryOrganizer) => {
+ for (const view of ["FULL", "BASIC"] as const) {
+ const existing = get().getSavedQueryByName(organizer.savedQuery, view);
+ if (!existing) continue;
+ const updated = clone(SavedQuerySchema, existing);
+ updated.starred = organizer.starred;
+ updated.folders = organizer.folders;
+ setCacheEntry(updated, view);
+ }
+ };
+
+ return {
+ savedQueriesByKey: {},
+ savedQueryRequests: {},
+
+ getSavedQueryByName: (name, view) => {
+ const uid = extractSavedQueryID(name);
+ if (!uid || uid === String(UNKNOWN_ID)) return undefined;
+ const byKey = get().savedQueriesByKey;
+ if (view === undefined) {
+ return byKey[cacheKey(uid, "FULL")] ?? byKey[cacheKey(uid, "BASIC")];
+ }
+ return byKey[cacheKey(uid, view)];
+ },
+
+ getOrFetchSavedQueryByName: async (name, silent = false) => {
+ const uid = extractSavedQueryID(name);
+ if (uid.startsWith("-") || !uid) return undefined;
+
+ const cached = get().savedQueriesByKey[cacheKey(uid, "FULL")];
+ if (cached) return cached;
+
+ const pending = get().savedQueryRequests[uid];
+ if (pending) return pending;
+
+ const promise = (async () => {
+ try {
+ const response = await savedQueryServiceClientConnect.getSavedQuery(
+ createProto(GetSavedQueryRequestSchema, { name }),
+ {
+ contextValues: createContextValues().set(
+ silentContextKey,
+ silent
+ ),
+ }
+ );
+ await hydrateRelatedResources([response]);
+ setCacheEntry(response, "FULL");
+ return response;
+ } catch {
+ return undefined;
+ } finally {
+ set((s) => {
+ const { [uid]: _removed, ...savedQueryRequests } =
+ s.savedQueryRequests;
+ return { savedQueryRequests };
+ });
+ }
+ })();
+
+ set((s) => ({
+ savedQueryRequests: { ...s.savedQueryRequests, [uid]: promise },
+ }));
+ return promise;
+ },
+
+ fetchSavedQueryList: async (parent, filter, params = {}) => {
+ const response = await savedQueryServiceClientConnect.searchSavedQueries(
+ createProto(SearchSavedQueriesRequestSchema, {
+ parent,
+ filter,
+ pageSize: params.pageSize,
+ pageToken: params.pageToken,
+ })
+ );
+ await hydrateRelatedResources(response.savedQueries);
+ for (const savedQuery of response.savedQueries) {
+ setCacheEntry(savedQuery, "BASIC");
+ }
+ return {
+ savedQueries: response.savedQueries,
+ nextPageToken: response.nextPageToken,
+ };
+ },
+
+ listSavedQueryFolders: async (parent) => {
+ const response =
+ await savedQueryServiceClientConnect.listSavedQueryFolders(
+ createProto(ListSavedQueryFoldersRequestSchema, {
+ parent,
+ })
+ );
+ const folders: { folders: string[]; category: "my" | "shared" }[] = [];
+ for (const folder of response.folders) {
+ switch (folder.category) {
+ case SavedQueryFolder_Category.MINE:
+ folders.push({ folders: folder.folders, category: "my" });
+ break;
+ case SavedQueryFolder_Category.SHARED:
+ folders.push({ folders: folder.folders, category: "shared" });
+ break;
+ }
+ }
+ return folders;
+ },
+
+ createSavedQuery: async (savedQuery) => {
+ const fullSavedQuery = savedQuery.name
+ ? savedQuery
+ : clone(SavedQuerySchema, savedQuery);
+ const response = await savedQueryServiceClientConnect.createSavedQuery(
+ createProto(CreateSavedQueryRequestSchema, {
+ parent: fullSavedQuery.project,
+ savedQuery: fullSavedQuery,
+ })
+ );
+ setCacheEntry(response, "FULL");
+ return response;
+ },
+
+ patchSavedQuery: async (savedQuery, updateMask, signal) => {
+ if (!savedQuery.name) return undefined;
+ const response = await savedQueryServiceClientConnect.updateSavedQuery(
+ createProto(UpdateSavedQueryRequestSchema, {
+ savedQuery,
+ updateMask: { paths: updateMask },
+ }),
+ { signal }
+ );
+ setCacheEntry(response, "FULL");
+ return response;
+ },
+
+ deleteSavedQueryByName: async (name) => {
+ await savedQueryServiceClientConnect.deleteSavedQuery(
+ createProto(DeleteSavedQueryRequestSchema, { name })
+ );
+ const uid = extractSavedQueryID(name);
+ set((s) => {
+ const {
+ [cacheKey(uid, "FULL")]: _f,
+ [cacheKey(uid, "BASIC")]: _b,
+ ...savedQueriesByKey
+ } = s.savedQueriesByKey;
+ return { savedQueriesByKey };
+ });
+ },
+
+ upsertSavedQueryOrganizer: async (organizer, updateMask) => {
+ const response =
+ await savedQueryServiceClientConnect.updateSavedQueryOrganizer(
+ createProto(UpdateSavedQueryOrganizerRequestSchema, {
+ organizer: createProto(SavedQueryOrganizerSchema, {
+ ...organizer,
+ } as SavedQueryOrganizer),
+ updateMask: { paths: updateMask },
+ })
+ );
+ updateCacheWithOrganizer(response);
+ },
+
+ batchUpdateSavedQueryOrganizers: async (requests) => {
+ const responses = await Promise.all(
+ requests.map((request) =>
+ savedQueryServiceClientConnect.batchUpdateSavedQueryOrganizer(
+ createProto(BatchUpdateSavedQueryOrganizerRequestSchema, {
+ parent: request.parent,
+ filter: request.filter,
+ organizer: createProto(SavedQueryOrganizerSchema, {
+ ...request.organizer,
+ } as SavedQueryOrganizer),
+ updateMask: { paths: request.updateMask },
+ })
+ )
+ )
+ );
+ for (const response of responses) {
+ response.savedQueryOrganizers.map(updateCacheWithOrganizer);
+ }
+ },
+
+ // The deduped full list. Callers split into "my" / "shared" using
+ // their own current-user source — the SQL editor uses the Pinia
+ // current user (reliably loaded before saved queries are fetched),
+ // whereas the app store's `currentUser` can lag on routes that don't
+ // load it eagerly.
+ savedQueryList: () =>
+ uniqBy(Object.values(get().savedQueriesByKey), (w) => w.name),
+ };
+};
diff --git a/frontend/src/stores/app/types.ts b/frontend/src/stores/app/types.ts
index d8a69ac39d..1630e8761e 100644
--- a/frontend/src/stores/app/types.ts
+++ b/frontend/src/stores/app/types.ts
@@ -63,6 +63,10 @@ import type { Release } from "@/types/proto-es/v1/release_service_pb";
import type { Revision } from "@/types/proto-es/v1/revision_service_pb";
import type { Role } from "@/types/proto-es/v1/role_service_pb";
import type { Rollout } from "@/types/proto-es/v1/rollout_service_pb";
+import type {
+ SavedQuery,
+ SavedQueryOrganizer,
+} from "@/types/proto-es/v1/saved_query_service_pb";
import type { ServiceAccount } from "@/types/proto-es/v1/service_account_service_pb";
import type {
DataClassificationSetting_DataClassificationConfig,
@@ -89,10 +93,6 @@ import type {
User,
} from "@/types/proto-es/v1/user_service_pb";
import type { WorkloadIdentity } from "@/types/proto-es/v1/workload_identity_service_pb";
-import type {
- Worksheet,
- WorksheetOrganizer,
-} from "@/types/proto-es/v1/worksheet_service_pb";
import type { Workspace } from "@/types/proto-es/v1/workspace_service_pb";
import type { Environment } from "@/types/v1/environment";
import type { IssueFilter } from "@/types/v1/issue/issue";
@@ -614,53 +614,53 @@ export type SheetSlice = {
getOrFetchSheetByName: (name: string) => Promise<Sheet | undefined>;
};
-export type WorksheetView = "FULL" | "BASIC";
+export type SavedQueryView = "FULL" | "BASIC";
-export type WorksheetSlice = {
+export type SavedQuerySlice = {
// Keyed by `${uid}:${view}` (mirrors the legacy Pinia cache, which kept
// FULL and BASIC views separately — BASIC list entries omit the
// statement, FULL entries carry it).
- worksheetsByKey: Record<string, Worksheet>;
- worksheetRequests: Record<string, Promise<Worksheet | undefined>>;
- getWorksheetByName: (
+ savedQueriesByKey: Record<string, SavedQuery>;
+ savedQueryRequests: Record<string, Promise<SavedQuery | undefined>>;
+ getSavedQueryByName: (
name: string,
- view?: WorksheetView
- ) => Worksheet | undefined;
- getOrFetchWorksheetByName: (
+ view?: SavedQueryView
+ ) => SavedQuery | undefined;
+ getOrFetchSavedQueryByName: (
name: string,
silent?: boolean
- ) => Promise<Worksheet | undefined>;
- fetchWorksheetList: (
+ ) => Promise<SavedQuery | undefined>;
+ fetchSavedQueryList: (
parent: string,
filter: string,
params?: {
pageSize?: number;
pageToken?: string;
}
- ) => Promise<{ worksheets: Worksheet[]; nextPageToken: string }>;
- listWorksheetFolders: (
+ ) => Promise<{ savedQueries: SavedQuery[]; nextPageToken: string }>;
+ listSavedQueryFolders: (
parent: string
) => Promise<{ folders: string[]; category: "my" | "shared" }[]>;
- createWorksheet: (worksheet: Worksheet) => Promise<Worksheet>;
- patchWorksheet: (
- worksheet: Worksheet,
+ createSavedQuery: (savedQuery: SavedQuery) => Promise<SavedQuery>;
+ patchSavedQuery: (
+ savedQuery: SavedQuery,
updateMask: string[],
signal?: AbortSignal
- ) => Promise<Worksheet | undefined>;
- deleteWorksheetByName: (name: string) => Promise<void>;
- upsertWorksheetOrganizer: (
- organizer: Partial<WorksheetOrganizer>,
+ ) => Promise<SavedQuery | undefined>;
+ deleteSavedQueryByName: (name: string) => Promise<void>;
+ upsertSavedQueryOrganizer: (
+ organizer: Partial<SavedQueryOrganizer>,
updateMask: string[]
) => Promise<void>;
- batchUpdateWorksheetOrganizers: (
+ batchUpdateSavedQueryOrganizers: (
requests: {
parent: string;
filter: string;
- organizer: Partial<WorksheetOrganizer>;
+ organizer: Partial<SavedQueryOrganizer>;
updateMask: string[];
}[]
) => Promise<void>;
- worksheetList: () => Worksheet[];
+ savedQueryList: () => SavedQuery[];
};
export type InstanceRoleSlice = {
@@ -1108,7 +1108,7 @@ export type AppStoreState = AuthSlice &
DatabaseSlice &
DBGroupSlice &
SheetSlice &
- WorksheetSlice &
+ SavedQuerySlice &
InstanceRoleSlice &
GroupSlice &
ServiceAccountSlice &
diff --git a/frontend/src/stores/app/worksheet.ts b/frontend/src/stores/app/worksheet.ts
deleted file mode 100644
index c6b11166d5..0000000000
--- a/frontend/src/stores/app/worksheet.ts
+++ /dev/null
@@ -1,262 +0,0 @@
-import { clone, create as createProto } from "@bufbuild/protobuf";
-import { createContextValues } from "@connectrpc/connect";
-import { uniq, uniqBy } from "lodash-es";
-import { worksheetServiceClientConnect } from "@/api";
-import { silentContextKey } from "@/api/context-key";
-import { UNKNOWN_ID } from "@/types";
-import type {
- Worksheet,
- WorksheetOrganizer,
-} from "@/types/proto-es/v1/worksheet_service_pb";
-import {
- BatchUpdateWorksheetOrganizerRequestSchema,
- CreateWorksheetRequestSchema,
- DeleteWorksheetRequestSchema,
- GetWorksheetRequestSchema,
- ListWorksheetFoldersRequestSchema,
- SearchWorksheetsRequestSchema,
- UpdateWorksheetOrganizerRequestSchema,
- UpdateWorksheetRequestSchema,
- WorksheetFolder_Category,
- WorksheetOrganizerSchema,
- WorksheetSchema,
-} from "@/types/proto-es/v1/worksheet_service_pb";
-import { isValidDatabaseName } from "@/types/v1/database";
-import { extractWorksheetID } from "@/utils/v1/worksheet";
-import type { AppSliceCreator, WorksheetSlice, WorksheetView } from "./types";
-
-const cacheKey = (uid: string, view: WorksheetView) => `${uid}:${view}`;
-
-/**
- * Zustand port of the legacy Pinia `useWorkSheetStore`. Worksheets are
- * keyed by `${uid}:${view}` so FULL (with statement) and BASIC (list)
- * views coexist, matching the old cache. Related resources (project,
- * database, creator) are hydrated through the sibling app slices rather
- * than the old Pinia stores.
- */
-export const createWorksheetSlice: AppSliceCreator<WorksheetSlice> = (
- set,
- get
-) => {
- const setCacheEntry = (worksheet: Worksheet, view: WorksheetView) => {
- const uid = extractWorksheetID(worksheet.name);
- if (uid === String(UNKNOWN_ID)) return;
- set((s) => {
- const worksheetsByKey = { ...s.worksheetsByKey };
- // A FULL entry supersedes any stale BASIC entry for the same uid.
- if (view === "FULL") {
- delete worksheetsByKey[cacheKey(uid, "BASIC")];
- }
- worksheetsByKey[cacheKey(uid, view)] = worksheet;
- return { worksheetsByKey };
- });
- };
-
- const hydrateRelatedResources = async (worksheets: Worksheet[]) => {
- // A worksheet without a connection has `database: ""`. The batch
- // endpoint rejects the whole request on an invalid name, which would
- // drop hydration for every valid database in the same batch, so filter
- // those out first. Dedupe all three to keep the batch payloads minimal.
- const databases = uniq(
- worksheets.map((w) => w.database).filter(isValidDatabaseName)
- );
- try {
- await Promise.all([
- get().batchFetchProjects(uniq(worksheets.map((w) => w.project))),
- get().batchFetchDatabases(databases),
- get().batchGetOrFetchUsers(uniq(worksheets.map((w) => w.creator))),
- ]);
- } catch {
- // Best-effort hydration; the worksheet entry is still cached below.
- }
- };
-
- const updateCacheWithOrganizer = (organizer: WorksheetOrganizer) => {
- for (const view of ["FULL", "BASIC"] as const) {
- const existing = get().getWorksheetByName(organizer.worksheet, view);
- if (!existing) continue;
- const updated = clone(WorksheetSchema, existing);
- updated.starred = organizer.starred;
- updated.folders = organizer.folders;
- setCacheEntry(updated, view);
- }
- };
-
- return {
- worksheetsByKey: {},
- worksheetRequests: {},
-
- getWorksheetByName: (name, view) => {
- const uid = extractWorksheetID(name);
- if (!uid || uid === String(UNKNOWN_ID)) return undefined;
- const byKey = get().worksheetsByKey;
- if (view === undefined) {
- return byKey[cacheKey(uid, "FULL")] ?? byKey[cacheKey(uid, "BASIC")];
- }
- return byKey[cacheKey(uid, view)];
- },
-
- getOrFetchWorksheetByName: async (name, silent = false) => {
- const uid = extractWorksheetID(name);
- if (uid.startsWith("-") || !uid) return undefined;
-
- const cached = get().worksheetsByKey[cacheKey(uid, "FULL")];
- if (cached) return cached;
-
- const pending = get().worksheetRequests[uid];
- if (pending) return pending;
-
- const promise = (async () => {
- try {
- const response = await worksheetServiceClientConnect.getWorksheet(
- createProto(GetWorksheetRequestSchema, { name }),
- {
- contextValues: createContextValues().set(
- silentContextKey,
- silent
- ),
- }
- );
- await hydrateRelatedResources([response]);
- setCacheEntry(response, "FULL");
- return response;
- } catch {
- return undefined;
- } finally {
- set((s) => {
- const { [uid]: _removed, ...worksheetRequests } =
- s.worksheetRequests;
- return { worksheetRequests };
- });
- }
- })();
-
- set((s) => ({
- worksheetRequests: { ...s.worksheetRequests, [uid]: promise },
- }));
- return promise;
- },
-
- fetchWorksheetList: async (parent, filter, params = {}) => {
- const response = await worksheetServiceClientConnect.searchWorksheets(
- createProto(SearchWorksheetsRequestSchema, {
- parent,
- filter,
- pageSize: params.pageSize,
- pageToken: params.pageToken,
- })
- );
- await hydrateRelatedResources(response.worksheets);
- for (const worksheet of response.worksheets) {
- setCacheEntry(worksheet, "BASIC");
- }
- return {
- worksheets: response.worksheets,
- nextPageToken: response.nextPageToken,
- };
- },
-
- listWorksheetFolders: async (parent) => {
- const response = await worksheetServiceClientConnect.listWorksheetFolders(
- createProto(ListWorksheetFoldersRequestSchema, {
- parent,
- })
- );
- const folders: { folders: string[]; category: "my" | "shared" }[] = [];
- for (const folder of response.folders) {
- switch (folder.category) {
- case WorksheetFolder_Category.MINE:
- folders.push({ folders: folder.folders, category: "my" });
- break;
- case WorksheetFolder_Category.SHARED:
- folders.push({ folders: folder.folders, category: "shared" });
- break;
- }
- }
- return folders;
- },
-
- createWorksheet: async (worksheet) => {
- const fullWorksheet = worksheet.name
- ? worksheet
- : clone(WorksheetSchema, worksheet);
- const response = await worksheetServiceClientConnect.createWorksheet(
- createProto(CreateWorksheetRequestSchema, {
- parent: fullWorksheet.project,
- worksheet: fullWorksheet,
- })
- );
- setCacheEntry(response, "FULL");
- return response;
- },
-
- patchWorksheet: async (worksheet, updateMask, signal) => {
- if (!worksheet.name) return undefined;
- const response = await worksheetServiceClientConnect.updateWorksheet(
- createProto(UpdateWorksheetRequestSchema, {
- worksheet,
- updateMask: { paths: updateMask },
- }),
- { signal }
- );
- setCacheEntry(response, "FULL");
- return response;
- },
-
- deleteWorksheetByName: async (name) => {
- await worksheetServiceClientConnect.deleteWorksheet(
- createProto(DeleteWorksheetRequestSchema, { name })
- );
- const uid = extractWorksheetID(name);
- set((s) => {
- const {
- [cacheKey(uid, "FULL")]: _f,
- [cacheKey(uid, "BASIC")]: _b,
- ...worksheetsByKey
- } = s.worksheetsByKey;
- return { worksheetsByKey };
- });
- },
-
- upsertWorksheetOrganizer: async (organizer, updateMask) => {
- const response =
- await worksheetServiceClientConnect.updateWorksheetOrganizer(
- createProto(UpdateWorksheetOrganizerRequestSchema, {
- organizer: createProto(WorksheetOrganizerSchema, {
- ...organizer,
- } as WorksheetOrganizer),
- updateMask: { paths: updateMask },
- })
- );
- updateCacheWithOrganizer(response);
- },
-
- batchUpdateWorksheetOrganizers: async (requests) => {
- const responses = await Promise.all(
- requests.map((request) =>
- worksheetServiceClientConnect.batchUpdateWorksheetOrganizer(
- createProto(BatchUpdateWorksheetOrganizerRequestSchema, {
- parent: request.parent,
- filter: request.filter,
- organizer: createProto(WorksheetOrganizerSchema, {
- ...request.organizer,
- } as WorksheetOrganizer),
- updateMask: { paths: request.updateMask },
- })
- )
- )
- );
- for (const response of responses) {
- response.worksheetOrganizers.map(updateCacheWithOrganizer);
- }
- },
-
- // The deduped full list. Callers split into "my" / "shared" using
- // their own current-user source — the SQL editor uses the Pinia
- // current user (reliably loaded before worksheets are fetched),
- // whereas the app store's `currentUser` can lag on routes that don't
- // load it eagerly.
- worksheetList: () =>
- uniqBy(Object.values(get().worksheetsByKey), (w) => w.name),
- };
-};
diff --git a/frontend/src/stores/modules/v1/common.ts b/frontend/src/stores/modules/v1/common.ts
index 1af72399f2..9b0e8f6c0d 100644
--- a/frontend/src/stores/modules/v1/common.ts
+++ b/frontend/src/stores/modules/v1/common.ts
@@ -14,7 +14,7 @@ export const idpNamePrefix = "idps/";
export const policyNamePrefix = "policies/";
export const settingNamePrefix = "settings/";
export const sheetNamePrefix = "sheets/";
-export const worksheetNamePrefix = "worksheets/";
+export const savedQueryNamePrefix = "savedQueries/";
export const databaseGroupNamePrefix = "databaseGroups/";
export const logNamePrefix = "logs/";
export const issueNamePrefix = "issues/";
@@ -163,10 +163,10 @@ export const getProjectIdPlanUidStageUidTaskUidFromRolloutName = (
return [projectId, planId, suffixParts[2], suffixParts[4]];
};
-export const getWorksheetId = (name: string): string => {
+export const getSavedQueryId = (name: string): string => {
const tokens = getNameParentTokens(name, [
projectNamePrefix,
- worksheetNamePrefix,
+ savedQueryNamePrefix,
]);
return tokens[1] || "";
};
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
new file mode 100644
index 0000000000..334aec8d5a
--- /dev/null
+++ b/frontend/src/types/proto-es/v1/saved_query_service_pb.d.ts
@@ -0,0 +1,773 @@
+// @generated by protoc-gen-es v2.12.0
+// @generated from file v1/saved_query_service.proto (package bytebase.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { EmptySchema, FieldMask, Timestamp } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file v1/saved_query_service.proto.
+ */
+export declare const file_v1_saved_query_service: GenFile;
+
+/**
+ * @generated from message bytebase.v1.CreateSavedQueryRequest
+ */
+export declare type CreateSavedQueryRequest = Message<"bytebase.v1.CreateSavedQueryRequest"> & {
+ /**
+ * The parent resource where this saved query will be created.
+ * Format: projects/{project}
+ *
+ * @generated from field: string parent = 1;
+ */
+ parent: string;
+
+ /**
+ * The saved query to create.
+ *
+ * @generated from field: bytebase.v1.SavedQuery saved_query = 2;
+ */
+ savedQuery?: SavedQuery | undefined;
+};
+
+/**
+ * Describes the message bytebase.v1.CreateSavedQueryRequest.
+ * Use `create(CreateSavedQueryRequestSchema)` to create a new message.
+ */
+export declare const CreateSavedQueryRequestSchema: GenMessage<CreateSavedQueryRequest>;
+
+/**
+ * @generated from message bytebase.v1.GetSavedQueryRequest
+ */
+export declare type GetSavedQueryRequest = Message<"bytebase.v1.GetSavedQueryRequest"> & {
+ /**
+ * The name of the saved query to retrieve.
+ * Format: projects/{project}/savedQueries/{savedQuery}
+ *
+ * @generated from field: string name = 1;
+ */
+ name: string;
+};
+
+/**
+ * Describes the message bytebase.v1.GetSavedQueryRequest.
+ * Use `create(GetSavedQueryRequestSchema)` to create a new message.
+ */
+export declare const GetSavedQueryRequestSchema: GenMessage<GetSavedQueryRequest>;
+
+/**
+ * @generated from message bytebase.v1.ListSavedQueriesRequest
+ */
+export declare type ListSavedQueriesRequest = Message<"bytebase.v1.ListSavedQueriesRequest"> & {
+ /**
+ * The parent resource of the saved queries.
+ * Format: projects/{project}
+ * Use "projects/-" to list saved queries across all projects.
+ *
+ * @generated from field: string parent = 1;
+ */
+ parent: string;
+
+ /**
+ * To filter the list result.
+ * The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ *
+ * Supported filter:
+ * - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ *
+ * For example:
+ * creator == "users/{email}"
+ * creator != "users/{email}"
+ *
+ * @generated from field: string filter = 2;
+ */
+ filter: string;
+
+ /**
+ * The maximum number of saved queries to return. The service may return fewer than
+ * this value.
+ * If unspecified, at most 10 saved queries will be returned.
+ * The maximum value is 1000; values above 1000 will be coerced to 1000.
+ *
+ * @generated from field: int32 page_size = 3;
+ */
+ pageSize: number;
+
+ /**
+ * A page token, received from a previous `ListSavedQueries` call.
+ * Provide this to retrieve the subsequent page.
+ *
+ * When paginating, all other parameters provided to `ListSavedQueries` must match
+ * the call that provided the page token.
+ *
+ * @generated from field: string page_token = 4;
+ */
+ pageToken: string;
+};
+
+/**
+ * Describes the message bytebase.v1.ListSavedQueriesRequest.
+ * Use `create(ListSavedQueriesRequestSchema)` to create a new message.
+ */
+export declare const ListSavedQueriesRequestSchema: GenMessage<ListSavedQueriesRequest>;
+
+/**
+ * @generated from message bytebase.v1.ListSavedQueriesResponse
+ */
+export declare type ListSavedQueriesResponse = Message<"bytebase.v1.ListSavedQueriesResponse"> & {
+ /**
+ * The saved queries from the specified parent.
+ *
+ * @generated from field: repeated bytebase.v1.SavedQuery saved_queries = 1;
+ */
+ savedQueries: SavedQuery[];
+
+ /**
+ * A token to retrieve next page of saved queries.
+ * Pass this value in the page_token field in the subsequent call to
+ * `ListSavedQueries` method to retrieve the next page of saved queries.
+ *
+ * @generated from field: string next_page_token = 2;
+ */
+ nextPageToken: string;
+};
+
+/**
+ * Describes the message bytebase.v1.ListSavedQueriesResponse.
+ * Use `create(ListSavedQueriesResponseSchema)` to create a new message.
+ */
+export declare const ListSavedQueriesResponseSchema: GenMessage<ListSavedQueriesResponse>;
+
+/**
+ * @generated from message bytebase.v1.ListSavedQueryFoldersRequest
+ */
+export declare type ListSavedQueryFoldersRequest = Message<"bytebase.v1.ListSavedQueryFoldersRequest"> & {
+ /**
+ * The parent resource of the saved query folders.
+ * Format: projects/{project}
+ *
+ * @generated from field: string parent = 1;
+ */
+ parent: string;
+};
+
+/**
+ * Describes the message bytebase.v1.ListSavedQueryFoldersRequest.
+ * Use `create(ListSavedQueryFoldersRequestSchema)` to create a new message.
+ */
+export declare const ListSavedQueryFoldersRequestSchema: GenMessage<ListSavedQueryFoldersRequest>;
+
+/**
+ * @generated from message bytebase.v1.ListSavedQueryFoldersResponse
+ */
+export declare type ListSavedQueryFoldersResponse = Message<"bytebase.v1.ListSavedQueryFoldersResponse"> & {
+ /**
+ * The caller's saved query folders.
+ *
+ * @generated from field: repeated bytebase.v1.SavedQueryFolder folders = 1;
+ */
+ folders: SavedQueryFolder[];
+};
+
+/**
+ * Describes the message bytebase.v1.ListSavedQueryFoldersResponse.
+ * Use `create(ListSavedQueryFoldersResponseSchema)` to create a new message.
+ */
+export declare const ListSavedQueryFoldersResponseSchema: GenMessage<ListSavedQueryFoldersResponse>;
+
+/**
+ * @generated from message bytebase.v1.SavedQueryFolder
+ */
+export declare type SavedQueryFolder = Message<"bytebase.v1.SavedQueryFolder"> & {
+ /**
+ * The folder path segments.
+ *
+ * @generated from field: repeated string folders = 1;
+ */
+ folders: string[];
+
+ /**
+ * The folder category.
+ *
+ * @generated from field: bytebase.v1.SavedQueryFolder.Category category = 2;
+ */
+ category: SavedQueryFolder_Category;
+};
+
+/**
+ * Describes the message bytebase.v1.SavedQueryFolder.
+ * Use `create(SavedQueryFolderSchema)` to create a new message.
+ */
+export declare const SavedQueryFolderSchema: GenMessage<SavedQueryFolder>;
+
+/**
+ * @generated from enum bytebase.v1.SavedQueryFolder.Category
+ */
+export enum SavedQueryFolder_Category {
+ /**
+ * @generated from enum value: CATEGORY_UNSPECIFIED = 0;
+ */
+ CATEGORY_UNSPECIFIED = 0,
+
+ /**
+ * @generated from enum value: MINE = 1;
+ */
+ MINE = 1,
+
+ /**
+ * @generated from enum value: SHARED = 2;
+ */
+ SHARED = 2,
+}
+
+/**
+ * Describes the enum bytebase.v1.SavedQueryFolder.Category.
+ */
+export declare const SavedQueryFolder_CategorySchema: GenEnum<SavedQueryFolder_Category>;
+
+/**
+ * @generated from message bytebase.v1.UpdateSavedQueryRequest
+ */
+export declare type UpdateSavedQueryRequest = Message<"bytebase.v1.UpdateSavedQueryRequest"> & {
+ /**
+ * The saved query to update.
+ *
+ * The saved query's `name` field is used to identify the saved query to update.
+ * Format: projects/{project}/savedQueries/{savedQuery}
+ *
+ * @generated from field: bytebase.v1.SavedQuery saved_query = 1;
+ */
+ savedQuery?: SavedQuery | undefined;
+
+ /**
+ * The list of fields to be updated.
+ * Fields are specified relative to the saved query.
+ * (e.g., `title`, `statement`; *not* `saved_query.title` or `saved_query.statement`)
+ * Only support update the following fields for now:
+ * - `title`
+ * - `statement`
+ * - `starred`
+ * - `visibility`
+ *
+ * @generated from field: google.protobuf.FieldMask update_mask = 2;
+ */
+ updateMask?: FieldMask | undefined;
+};
+
+/**
+ * Describes the message bytebase.v1.UpdateSavedQueryRequest.
+ * Use `create(UpdateSavedQueryRequestSchema)` to create a new message.
+ */
+export declare const UpdateSavedQueryRequestSchema: GenMessage<UpdateSavedQueryRequest>;
+
+/**
+ * @generated from message bytebase.v1.BatchUpdateSavedQueryOrganizerRequest
+ */
+export declare type BatchUpdateSavedQueryOrganizerRequest = Message<"bytebase.v1.BatchUpdateSavedQueryOrganizerRequest"> & {
+ /**
+ * The parent resource whose saved queries' organizers are updated.
+ * Format: projects/{project}
+ *
+ * @generated from field: string parent = 1;
+ */
+ parent: string;
+
+ /**
+ * To filter the batch update target.
+ * The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ *
+ * Supported filter:
+ * - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ * - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ * - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ * - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ * - folder: the saved query organizer folder path, support exact "==" operator.
+ *
+ * @generated from field: string filter = 2;
+ */
+ filter: string;
+
+ /**
+ * The organizer fields to update.
+ *
+ * @generated from field: bytebase.v1.SavedQueryOrganizer organizer = 3;
+ */
+ organizer?: SavedQueryOrganizer | undefined;
+
+ /**
+ * The list of fields to be updated.
+ * Fields are specified relative to the saved query organizer.
+ * Only support update the following fields for now:
+ * - `starred`
+ * - `folders`
+ *
+ * @generated from field: google.protobuf.FieldMask update_mask = 4;
+ */
+ updateMask?: FieldMask | undefined;
+};
+
+/**
+ * Describes the message bytebase.v1.BatchUpdateSavedQueryOrganizerRequest.
+ * Use `create(BatchUpdateSavedQueryOrganizerRequestSchema)` to create a new message.
+ */
+export declare const BatchUpdateSavedQueryOrganizerRequestSchema: GenMessage<BatchUpdateSavedQueryOrganizerRequest>;
+
+/**
+ * @generated from message bytebase.v1.BatchUpdateSavedQueryOrganizerResponse
+ */
+export declare type BatchUpdateSavedQueryOrganizerResponse = Message<"bytebase.v1.BatchUpdateSavedQueryOrganizerResponse"> & {
+ /**
+ * @generated from field: repeated bytebase.v1.SavedQueryOrganizer saved_query_organizers = 1;
+ */
+ savedQueryOrganizers: SavedQueryOrganizer[];
+
+ /**
+ * @generated from field: int32 updated_count = 2;
+ */
+ updatedCount: number;
+};
+
+/**
+ * Describes the message bytebase.v1.BatchUpdateSavedQueryOrganizerResponse.
+ * Use `create(BatchUpdateSavedQueryOrganizerResponseSchema)` to create a new message.
+ */
+export declare const BatchUpdateSavedQueryOrganizerResponseSchema: GenMessage<BatchUpdateSavedQueryOrganizerResponse>;
+
+/**
+ * @generated from message bytebase.v1.UpdateSavedQueryOrganizerRequest
+ */
+export declare type UpdateSavedQueryOrganizerRequest = Message<"bytebase.v1.UpdateSavedQueryOrganizerRequest"> & {
+ /**
+ * The organizer to update.
+ *
+ * The organizer's `saved_query` field is used to identify the saved query.
+ * Format: projects/{project}/savedQueries/{savedQuery}
+ *
+ * @generated from field: bytebase.v1.SavedQueryOrganizer organizer = 1;
+ */
+ organizer?: SavedQueryOrganizer | undefined;
+
+ /**
+ * The list of fields to be updated.
+ * Fields are specified relative to the saved query organizer.
+ * Only support update the following fields for now:
+ * - `starred`
+ *
+ * @generated from field: google.protobuf.FieldMask update_mask = 2;
+ */
+ updateMask?: FieldMask | undefined;
+
+ /**
+ * If set to true, and the saved query organizer is not found, a new saved query organizer will be created.
+ * In this situation, `update_mask` is ignored.
+ *
+ * @generated from field: bool allow_missing = 3;
+ */
+ allowMissing: boolean;
+};
+
+/**
+ * Describes the message bytebase.v1.UpdateSavedQueryOrganizerRequest.
+ * Use `create(UpdateSavedQueryOrganizerRequestSchema)` to create a new message.
+ */
+export declare const UpdateSavedQueryOrganizerRequestSchema: GenMessage<UpdateSavedQueryOrganizerRequest>;
+
+/**
+ * @generated from message bytebase.v1.SavedQueryOrganizer
+ */
+export declare type SavedQueryOrganizer = Message<"bytebase.v1.SavedQueryOrganizer"> & {
+ /**
+ * The name of the saved query.
+ * Format: projects/{project}/savedQueries/{savedQuery}
+ *
+ * @generated from field: string saved_query = 1;
+ */
+ savedQuery: string;
+
+ /**
+ * starred means if the saved query is starred.
+ *
+ * @generated from field: bool starred = 2;
+ */
+ starred: boolean;
+
+ /**
+ * @generated from field: repeated string folders = 3;
+ */
+ folders: string[];
+};
+
+/**
+ * Describes the message bytebase.v1.SavedQueryOrganizer.
+ * Use `create(SavedQueryOrganizerSchema)` to create a new message.
+ */
+export declare const SavedQueryOrganizerSchema: GenMessage<SavedQueryOrganizer>;
+
+/**
+ * @generated from message bytebase.v1.DeleteSavedQueryRequest
+ */
+export declare type DeleteSavedQueryRequest = Message<"bytebase.v1.DeleteSavedQueryRequest"> & {
+ /**
+ * The name of the saved query to delete.
+ * Format: projects/{project}/savedQueries/{savedQuery}
+ *
+ * @generated from field: string name = 1;
+ */
+ name: string;
+};
+
+/**
+ * Describes the message bytebase.v1.DeleteSavedQueryRequest.
+ * Use `create(DeleteSavedQueryRequestSchema)` to create a new message.
+ */
+export declare const DeleteSavedQueryRequestSchema: GenMessage<DeleteSavedQueryRequest>;
+
+/**
+ * @generated from message bytebase.v1.SearchSavedQueriesRequest
+ */
+export declare type SearchSavedQueriesRequest = Message<"bytebase.v1.SearchSavedQueriesRequest"> & {
+ /**
+ * The parent resource of the saved queries.
+ * Format: projects/{project}
+ *
+ * @generated from field: string parent = 1;
+ */
+ parent: string;
+
+ /**
+ * To filter the search result.
+ * The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ *
+ * Supported filter:
+ * - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ * - title: the saved query title, support "contains" operator.
+ * - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ * - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ * - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ * - folder: the saved query organizer folder path, support "==" operator.
+ *
+ * For example:
+ * creator == "users/{email}"
+ * title.contains("saved query title")
+ * creator != "users/{email}"
+ * starred == true
+ * starred == false
+ * visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
+ * visibility == "PRIVATE"
+ * folder == "foo/bar"
+ *
+ * @generated from field: string filter = 2;
+ */
+ filter: string;
+
+ /**
+ * The maximum number of saved queries to return. The service may return fewer than
+ * this value.
+ * If unspecified, at most 10 saved queries will be returned.
+ * The maximum value is 1000; values above 1000 will be coerced to 1000.
+ *
+ * @generated from field: int32 page_size = 3;
+ */
+ pageSize: number;
+
+ /**
+ * A page token, received from a previous `SearchSavedQueries` call.
+ * Provide this to retrieve the subsequent page.
+ *
+ * @generated from field: string page_token = 4;
+ */
+ pageToken: string;
+};
+
+/**
+ * Describes the message bytebase.v1.SearchSavedQueriesRequest.
+ * Use `create(SearchSavedQueriesRequestSchema)` to create a new message.
+ */
+export declare const SearchSavedQueriesRequestSchema: GenMessage<SearchSavedQueriesRequest>;
+
+/**
+ * @generated from message bytebase.v1.SearchSavedQueriesResponse
+ */
+export declare type SearchSavedQueriesResponse = Message<"bytebase.v1.SearchSavedQueriesResponse"> & {
+ /**
+ * The saved queries that matched the search criteria.
+ *
+ * @generated from field: repeated bytebase.v1.SavedQuery saved_queries = 1;
+ */
+ savedQueries: SavedQuery[];
+
+ /**
+ * A token to retrieve next page of saved queries.
+ * Pass this value in the page_token field in the subsequent call to
+ * `SearchSavedQueries` method to retrieve the next page of saved queries.
+ *
+ * @generated from field: string next_page_token = 2;
+ */
+ nextPageToken: string;
+};
+
+/**
+ * Describes the message bytebase.v1.SearchSavedQueriesResponse.
+ * Use `create(SearchSavedQueriesResponseSchema)` to create a new message.
+ */
+export declare const SearchSavedQueriesResponseSchema: GenMessage<SearchSavedQueriesResponse>;
+
+/**
+ * @generated from message bytebase.v1.SavedQuery
+ */
+export declare type SavedQuery = Message<"bytebase.v1.SavedQuery"> & {
+ /**
+ * The name of the saved query resource, generated by the server.
+ * Canonical parent is project.
+ * Format: projects/{project}/savedQueries/{savedQuery}
+ *
+ * @generated from field: string name = 1;
+ */
+ name: string;
+
+ /**
+ * The project resource name.
+ * Format: projects/{project}
+ *
+ * @generated from field: string project = 2;
+ */
+ project: string;
+
+ /**
+ * The database resource name.
+ * Format: instances/{instance}/databases/{database}
+ * If the database parent doesn't exist, the database field is empty.
+ *
+ * @generated from field: string database = 3;
+ */
+ database: string;
+
+ /**
+ * The title of the saved query.
+ *
+ * @generated from field: string title = 4;
+ */
+ title: string;
+
+ /**
+ * The creator of the SavedQuery.
+ * Format: users/{email}
+ *
+ * @generated from field: string creator = 5;
+ */
+ creator: string;
+
+ /**
+ * The create time of the saved query.
+ *
+ * @generated from field: google.protobuf.Timestamp create_time = 6;
+ */
+ createTime?: Timestamp | undefined;
+
+ /**
+ * The last update time of the saved query.
+ *
+ * @generated from field: google.protobuf.Timestamp update_time = 7;
+ */
+ updateTime?: Timestamp | undefined;
+
+ /**
+ * The content of the saved query.
+ * By default, it will be cut off in SearchSavedQueries() method. If it doesn't match the `content_size`, you can
+ * use GetSavedQuery() request to retrieve the full content.
+ *
+ * @generated from field: bytes content = 8;
+ */
+ content: Uint8Array;
+
+ /**
+ * content_size is the full size of the content, may not match the size of the `content` field.
+ *
+ * @generated from field: int64 content_size = 9;
+ */
+ contentSize: bigint;
+
+ /**
+ * @generated from field: bytebase.v1.SavedQuery.Visibility visibility = 10;
+ */
+ visibility: SavedQuery_Visibility;
+
+ /**
+ * starred indicates whether the saved query is starred by the current authenticated user.
+ *
+ * @generated from field: bool starred = 11;
+ */
+ starred: boolean;
+
+ /**
+ * @generated from field: repeated string folders = 12;
+ */
+ folders: string[];
+};
+
+/**
+ * Describes the message bytebase.v1.SavedQuery.
+ * Use `create(SavedQuerySchema)` to create a new message.
+ */
+export declare const SavedQuerySchema: GenMessage<SavedQuery>;
+
+/**
+ * @generated from enum bytebase.v1.SavedQuery.Visibility
+ */
+export enum SavedQuery_Visibility {
+ /**
+ * @generated from enum value: VISIBILITY_UNSPECIFIED = 0;
+ */
+ VISIBILITY_UNSPECIFIED = 0,
+
+ /**
+ * Read access in project scope, saved query OWNER/DBA and project OWNER can read/write, other project members can read.
+ *
+ * @generated from enum value: PROJECT_READ = 1;
+ */
+ PROJECT_READ = 1,
+
+ /**
+ * Write access in project scope, saved query OWNER/DBA and all members in the project can write the saved query.
+ *
+ * @generated from enum value: PROJECT_WRITE = 2;
+ */
+ PROJECT_WRITE = 2,
+
+ /**
+ * Private, only saved query OWNER can read/write.
+ *
+ * @generated from enum value: PRIVATE = 3;
+ */
+ PRIVATE = 3,
+}
+
+/**
+ * Describes the enum bytebase.v1.SavedQuery.Visibility.
+ */
+export declare const SavedQuery_VisibilitySchema: GenEnum<SavedQuery_Visibility>;
+
+/**
+ * SavedQueryService manages saved queries for SQL Editor query development.
+ * Permission IDs still use the legacy `bb.worksheets.*` names; they are
+ * renamed together with the access-model redesign and its role migration.
+ *
+ * @generated from service bytebase.v1.SavedQueryService
+ */
+export declare const SavedQueryService: GenService<{
+ /**
+ * Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries.
+ * Permissions required: None (authenticated users only)
+ *
+ * @generated from rpc bytebase.v1.SavedQueryService.CreateSavedQuery
+ */
+ createSavedQuery: {
+ methodKind: "unary";
+ input: typeof CreateSavedQueryRequestSchema;
+ output: typeof SavedQuerySchema;
+ },
+ /**
+ * Get a saved query by name.
+ * The users can access this method if,
+ * - they are the creator of the saved query;
+ * - they have bb.worksheets.get permission on the workspace;
+ * - the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ * Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ *
+ * @generated from rpc bytebase.v1.SavedQueryService.GetSavedQuery
+ */
+ getSavedQuery: {
+ methodKind: "unary";
+ input: typeof GetSavedQueryRequestSchema;
+ output: typeof SavedQuerySchema;
+ },
+ /**
+ * List saved queries.
+ * This is used for listing saved queries in a project, or across all projects by using `projects/-`.
+ * Permissions required: bb.worksheets.list
+ *
+ * @generated from rpc bytebase.v1.SavedQueryService.ListSavedQueries
+ */
+ listSavedQueries: {
+ methodKind: "unary";
+ input: typeof ListSavedQueriesRequestSchema;
+ output: typeof ListSavedQueriesResponseSchema;
+ },
+ /**
+ * List the caller's saved query folders.
+ * Only folders stored in the caller's saved query organizer are returned.
+ *
+ * @generated from rpc bytebase.v1.SavedQueryService.ListSavedQueryFolders
+ */
+ listSavedQueryFolders: {
+ methodKind: "unary";
+ input: typeof ListSavedQueryFoldersRequestSchema;
+ output: typeof ListSavedQueryFoldersResponseSchema;
+ },
+ /**
+ * Search for saved queries.
+ * This is used for finding my saved queries or saved queries shared by other people.
+ * The saved query accessibility is the same as GetSavedQuery().
+ * Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ *
+ * @generated from rpc bytebase.v1.SavedQueryService.SearchSavedQueries
+ */
+ searchSavedQueries: {
+ methodKind: "unary";
+ input: typeof SearchSavedQueriesRequestSchema;
+ output: typeof SearchSavedQueriesResponseSchema;
+ },
+ /**
+ * Update a saved query.
+ * The users can access this method if,
+ * - they are the creator of the saved query;
+ * - they have bb.worksheets.manage permission on the workspace;
+ * - the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ * Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ *
+ * @generated from rpc bytebase.v1.SavedQueryService.UpdateSavedQuery
+ */
+ updateSavedQuery: {
+ methodKind: "unary";
+ input: typeof UpdateSavedQueryRequestSchema;
+ output: typeof SavedQuerySchema;
+ },
+ /**
+ * Update the organizer of a saved query.
+ * The access is the same as UpdateSavedQuery method.
+ * Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ *
+ * @generated from rpc bytebase.v1.SavedQueryService.UpdateSavedQueryOrganizer
+ */
+ updateSavedQueryOrganizer: {
+ methodKind: "unary";
+ input: typeof UpdateSavedQueryOrganizerRequestSchema;
+ output: typeof SavedQueryOrganizerSchema;
+ },
+ /**
+ * Batch update the organizers of saved queries.
+ * The access is the same as UpdateSavedQuery method.
+ * Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ *
+ * @generated from rpc bytebase.v1.SavedQueryService.BatchUpdateSavedQueryOrganizer
+ */
+ batchUpdateSavedQueryOrganizer: {
+ methodKind: "unary";
+ input: typeof BatchUpdateSavedQueryOrganizerRequestSchema;
+ output: typeof BatchUpdateSavedQueryOrganizerResponseSchema;
+ },
+ /**
+ * Delete a saved query.
+ * The access is the same as UpdateSavedQuery method.
+ * Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ *
+ * @generated from rpc bytebase.v1.SavedQueryService.DeleteSavedQuery
+ */
+ deleteSavedQuery: {
+ methodKind: "unary";
+ input: typeof DeleteSavedQueryRequestSchema;
+ output: typeof EmptySchema;
+ },
+}>;
+
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
new file mode 100644
index 0000000000..8cbdcef511
--- /dev/null
+++ b/frontend/src/types/proto-es/v1/saved_query_service_pb.js
@@ -0,0 +1,165 @@
+// @generated by protoc-gen-es v2.12.0
+// @generated from file v1/saved_query_service.proto (package bytebase.v1, syntax proto3)
+/* eslint-disable */
+
+import { enumDesc, fileDesc, messageDesc, serviceDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
+import { file_buf_validate_validate } from "../buf/validate/validate_pb";
+import { file_google_api_annotations } from "../google/api/annotations_pb";
+import { file_google_api_client } from "../google/api/client_pb";
+import { file_google_api_field_behavior } from "../google/api/field_behavior_pb";
+import { file_google_api_resource } from "../google/api/resource_pb";
+import { file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
+import { file_v1_annotation } from "./annotation_pb";
+
+/**
+ * Describes the file v1/saved_query_service.proto.
+ */
+export const file_v1_saved_query_service = /*@__PURE__*/
+ fileDesc("Chx2MS9zYXZlZF9xdWVyeV9zZXJ2aWNlLnByb3RvEgtieXRlYmFzZS52MSJhChdDcmVhdGVTYXZlZFF1ZXJ5UmVxdWVzdBITCgZwYXJlbnQYASABKAlCA+BBAhIxCgtzYXZlZF9xdWVyeRgCIAEoCzIXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnlCA+BBAiIpChRHZXRTYXZlZFF1ZXJ5UmVxdWVzdBIRCgRuYW1lGAEgASgJQgPgQQIifgoXTGlzdFNhdmVkUXVlcmllc1JlcXVlc3QSLAoGcGFyZW50GAEgASgJQhzgQQL6QRYKFGJ5dGViYXNlLmNvbS9Qcm9qZWN0Eg4KBmZpbHRlchgCIAEoCRIRCglwYWdlX3NpemUYAyABKAUSEgoKcGFnZV90b2tlbhgEIAEoCSJjChhMaXN0U2F2ZWRRdWVyaWVzUmVzcG9uc2USLgoNc2F2ZWRfcXVlcmllcxgBIAMoCzIXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnkSFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJIjMKHExpc3RTYXZlZFF1ZXJ5Rm9sZGVyc1JlcXVlc3QSEwoGcGFyZW50GAEgASgJQgPgQQIiTwodTGlzdFNhdmVkUXVlcnlGb2xkZXJzUmVzcG9uc2USLgoHZm9sZGVycxgBIAMoCzIdLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnlGb2xkZXIimQEKEFNhdmVkUXVlcnlGb2xkZXISDwoHZm9sZGVycxgBIAMoCRI4CghjYXRlZ29yeRgCIAEoDjImLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnlGb2xkZXIuQ2F0ZWdvcnkiOgoIQ2F0ZWdvcnkSGAoUQ0FURUdPUllfVU5TUEVDSUZJRUQQABIICgRNSU5FEAESCgoGU0hBUkVEEAIifQoXVXBkYXRlU2F2ZWRRdWVyeVJlcXVlc3QSMQoLc2F2ZWRfcXVlcnkYASABKAsyFy5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5QgPgQQISLwoLdXBkYXRlX21hc2sYAiABKAsyGi5nb29nbGUucHJvdG9idWYuRmllbGRNYXNrIrwBCiVCYXRjaFVwZGF0ZVNhdmVkUXVlcnlPcmdhbml6ZXJSZXF1ZXN0EhMKBnBhcmVudBgBIAEoCUID4EECEg4KBmZpbHRlchgCIAEoCRI4Cglvcmdhbml6ZXIYAyABKAsyIC5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5T3JnYW5pemVyQgPgQQISNAoLdXBkYXRlX21hc2sYBCABKAsyGi5nb29nbGUucHJvdG9idWYuRmllbGRNYXNrQgPgQQIigQEKJkJhdGNoVXBkYXRlU2F2ZWRRdWVyeU9yZ2FuaXplclJlc3BvbnNlEkAKFnNhdmVkX3F1ZXJ5X29yZ2FuaXplcnMYASADKAsyIC5ieXRlYmFzZS52MS5TYXZlZFF1ZXJ5T3JnYW5pemVyEhUKDXVwZGF0ZWRfY291bnQYAiABKAUipAEKIFVwZGF0ZVNhdmVkUXVlcnlPcmdhbml6ZXJSZXF1ZXN0EjgKCW9yZ2FuaXplchgBIAEoCzIgLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnlPcmdhbml6ZXJCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJRChNTYXZlZFF1ZXJ5T3JnYW5pemVyEhgKC3NhdmVkX3F1ZXJ5GAEgASgJQgPgQQISDwoHc3RhcnJlZBgCIAEoCBIPCgdmb2xkZXJzGAMgAygJIiwKF0RlbGV0ZVNhdmVkUXVlcnlSZXF1ZXN0EhEKBG5hbWUYASABKAlCA+BBAiJnChlTZWFyY2hTYXZlZFF1ZXJpZXNSZXF1ZXN0EhMKBnBhcmVudBgBIAEoCUID4EECEg4KBmZpbHRlchgCIAEoCRIRCglwYWdlX3NpemUYAyABKAUSEgoKcGFnZV90b2tlbhgEIAEoCSJlChpTZWFyY2hTYXZlZFF1ZXJpZXNSZXNwb25zZRIuCg1zYXZlZF9xdWVyaWVzGAEgAygLMhcuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeRIXCg9uZXh0X3BhZ2VfdG9rZW4YAiABKAki3gMKClNhdmVkUXVlcnkSFAoEbmFtZRgBIAEoCUIG4EEC4EEFEhQKB3Byb2plY3QYAiABKAlCA+BBAxIQCghkYXRhYmFzZRgDIAEoCRIaCgV0aXRsZRgEIAEoCUIL4EECukgFcgMYyAESFAoHY3JlYXRvchgFIAEoCUID4EEDEjQKC2NyZWF0ZV90aW1lGAYgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEjQKC3VwZGF0ZV90aW1lGAcgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEID4EEDEhQKB2NvbnRlbnQYCCABKAxCA+BBAhIZCgxjb250ZW50X3NpemUYCSABKANCA+BBAxI7Cgp2aXNpYmlsaXR5GAogASgOMiIuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeS5WaXNpYmlsaXR5QgPgQQISFAoHc3RhcnJlZBgLIAEoCEID4EEDEhQKB2ZvbGRlcnMYDCADKAlCA+BBAyJaCgpWaXNpYmlsaXR5EhoKFlZJU0lCSUxJVFlfVU5TUEVDSUZJRUQQABIQCgxQUk9KRUNUX1JFQUQQARIRCg1QUk9KRUNUX1dSSVRFEAISCwoHUFJJVkFURRADMu4MChFTYXZlZFF1ZXJ5U2VydmljZRKlAQoQQ3JlYXRlU2F2ZWRRdWVyeRIkLmJ5dGViYXNlLnYxLkNyZWF0ZVNhdmVkUXVlcnlSZXF1ZXN0GhcuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeSJS2kEScGFyZW50LHNhdmVkX3F1ZXJ5kOowAoLT5JMCMzoLc2F2ZWRfcXVlcnkiJC92MS97cGFyZW50PXByb2plY3RzLyp9L3NhdmVkUXVlcmllcxKEAQoNR2V0U2F2ZWRRdWVyeRIhLmJ5dGViYXNlLnYxLkdldFNhdmVkUXVlcnlSZXF1ZXN0GhcuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeSI32kEEbmFtZZDqMAKC0+STAiYSJC92MS97bmFtZT1wcm9qZWN0cy8qL3NhdmVkUXVlcmllcy8qfRKwAQoQTGlzdFNhdmVkUXVlcmllcxIkLmJ5dGViYXNlLnYxLkxpc3RTYXZlZFF1ZXJpZXNSZXF1ZXN0GiUuYnl0ZWJhc2UudjEuTGlzdFNhdmVkUXVlcmllc1Jlc3BvbnNlIk/aQQZwYXJlbnSK6jASYmIud29ya3NoZWV0cy5saXN0kOowAYLT5JMCJhIkL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vc2F2ZWRRdWVyaWVzEq4BChVMaXN0U2F2ZWRRdWVyeUZvbGRlcnMSKS5ieXRlYmFzZS52MS5MaXN0U2F2ZWRRdWVyeUZvbGRlcnNSZXF1ZXN0GiouYnl0ZWJhc2UudjEuTGlzdFNhdmVkUXVlcnlGb2xkZXJzUmVzcG9uc2UiPtpBBnBhcmVudJDqMAKC0+STAisSKS92MS97cGFyZW50PXByb2plY3RzLyp9L3NhdmVkUXVlcnlGb2xkZXJzEqoBChJTZWFyY2hTYXZlZFF1ZXJpZXMSJi5ieXRlYmFzZS52MS5TZWFyY2hTYXZlZFF1ZXJpZXNSZXF1ZXN0GicuYnl0ZWJhc2UudjEuU2VhcmNoU2F2ZWRRdWVyaWVzUmVzcG9uc2UiQ9pBBnBhcmVudJDqMAKC0+STAjA6ASoiKy92MS97cGFyZW50PXByb2plY3RzLyp9L3NhdmVkUXVlcmllczpzZWFyY2gStgEKEFVwZGF0ZVNhdmVkUXVlcnkSJC5ieXRlYmFzZS52MS5VcGRhdGVTYXZlZFF1ZXJ5UmVxdWVzdBoXLmJ5dGViYXNlLnYxLlNhdmVkUXVlcnkiY9pBF3NhdmVkX3F1ZXJ5LHVwZGF0ZV9tYXNrkOowAoLT5JMCPzoLc2F2ZWRfcXVlcnkyMC92MS97c2F2ZWRfcXVlcnkubmFtZT1wcm9qZWN0cy8qL3NhdmVkUXVlcmllcy8qfRLcAQoZVXBkYXRlU2F2ZWRRdWVyeU9yZ2FuaXplchItLmJ5dGViYXNlLnYxLlVwZGF0ZVNhdmVkUXVlcnlPcmdhbml6ZXJSZXF1ZXN0GiAuYnl0ZWJhc2UudjEuU2F2ZWRRdWVyeU9yZ2FuaXplciJu2kEVb3JnYW5pemVyLHVwZGF0ZV9tYXNrkOowAoLT5JMCTDoJb3JnYW5pemVyMj8vdjEve29yZ2FuaXplci5zYXZlZF9xdWVyeT1wcm9qZWN0cy8qL3NhdmVkUXVlcmllcy8qfS9vcmdhbml6ZXIS9AEKHkJhdGNoVXBkYXRlU2F2ZWRRdWVyeU9yZ2FuaXplchIyLmJ5dGViYXNlLnYxLkJhdGNoVXBkYXRlU2F2ZWRRdWVyeU9yZ2FuaXplclJlcXVlc3QaMy5ieXRlYmFzZS52MS5CYXRjaFVwZGF0ZVNhdmVkUXVlcnlPcmdhbml6ZXJSZXNwb25zZSJp2kEccGFyZW50LG9yZ2FuaXplcix1cGRhdGVfbWFza5DqMAKC0+STAkA6ASoiOy92MS97cGFyZW50PXByb2plY3RzLyp9L3NhdmVkUXVlcmllcy9vcmdhbml6ZXJzOmJhdGNoVXBkYXRlEokBChBEZWxldGVTYXZlZFF1ZXJ5EiQuYnl0ZWJhc2UudjEuRGVsZXRlU2F2ZWRRdWVyeVJlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiN9pBBG5hbWWQ6jACgtPkkwImKiQvdjEve25hbWU9cHJvamVjdHMvKi9zYXZlZFF1ZXJpZXMvKn1CrAEKD2NvbS5ieXRlYmFzZS52MUIWU2F2ZWRRdWVyeVNlcnZpY2VQcm90b1ABWjRnaXRodWIuY29tL2J5dGViYXNlL2J5dGViYXNlL2JhY2tlbmQvZ2VuZXJhdGVkLWdvL3YxogIDQlhYqgILQnl0ZWJhc2UuVjHKAgtCeXRlYmFzZVxWMeICF0J5dGViYXNlXFYxXEdQQk1ldGFkYXRh6gIMQnl0ZWJhc2U6OlYxYgZwcm90bzM", [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.
+ * Use `create(CreateSavedQueryRequestSchema)` to create a new message.
+ */
+export const CreateSavedQueryRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 0);
+
+/**
+ * Describes the message bytebase.v1.GetSavedQueryRequest.
+ * Use `create(GetSavedQueryRequestSchema)` to create a new message.
+ */
+export const GetSavedQueryRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 1);
+
+/**
+ * Describes the message bytebase.v1.ListSavedQueriesRequest.
+ * Use `create(ListSavedQueriesRequestSchema)` to create a new message.
+ */
+export const ListSavedQueriesRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 2);
+
+/**
+ * Describes the message bytebase.v1.ListSavedQueriesResponse.
+ * Use `create(ListSavedQueriesResponseSchema)` to create a new message.
+ */
+export const ListSavedQueriesResponseSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 3);
+
+/**
+ * Describes the message bytebase.v1.ListSavedQueryFoldersRequest.
+ * Use `create(ListSavedQueryFoldersRequestSchema)` to create a new message.
+ */
+export const ListSavedQueryFoldersRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 4);
+
+/**
+ * Describes the message bytebase.v1.ListSavedQueryFoldersResponse.
+ * Use `create(ListSavedQueryFoldersResponseSchema)` to create a new message.
+ */
+export const ListSavedQueryFoldersResponseSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 5);
+
+/**
+ * Describes the message bytebase.v1.SavedQueryFolder.
+ * Use `create(SavedQueryFolderSchema)` to create a new message.
+ */
+export const SavedQueryFolderSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 6);
+
+/**
+ * Describes the enum bytebase.v1.SavedQueryFolder.Category.
+ */
+export const SavedQueryFolder_CategorySchema = /*@__PURE__*/
+ enumDesc(file_v1_saved_query_service, 6, 0);
+
+/**
+ * @generated from enum bytebase.v1.SavedQueryFolder.Category
+ */
+export const SavedQueryFolder_Category = /*@__PURE__*/
+ tsEnum(SavedQueryFolder_CategorySchema);
+
+/**
+ * Describes the message bytebase.v1.UpdateSavedQueryRequest.
+ * Use `create(UpdateSavedQueryRequestSchema)` to create a new message.
+ */
+export const UpdateSavedQueryRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 7);
+
+/**
+ * Describes the message bytebase.v1.BatchUpdateSavedQueryOrganizerRequest.
+ * Use `create(BatchUpdateSavedQueryOrganizerRequestSchema)` to create a new message.
+ */
+export const BatchUpdateSavedQueryOrganizerRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 8);
+
+/**
+ * Describes the message bytebase.v1.BatchUpdateSavedQueryOrganizerResponse.
+ * Use `create(BatchUpdateSavedQueryOrganizerResponseSchema)` to create a new message.
+ */
+export const BatchUpdateSavedQueryOrganizerResponseSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 9);
+
+/**
+ * Describes the message bytebase.v1.UpdateSavedQueryOrganizerRequest.
+ * Use `create(UpdateSavedQueryOrganizerRequestSchema)` to create a new message.
+ */
+export const UpdateSavedQueryOrganizerRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 10);
+
+/**
+ * Describes the message bytebase.v1.SavedQueryOrganizer.
+ * Use `create(SavedQueryOrganizerSchema)` to create a new message.
+ */
+export const SavedQueryOrganizerSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 11);
+
+/**
+ * Describes the message bytebase.v1.DeleteSavedQueryRequest.
+ * Use `create(DeleteSavedQueryRequestSchema)` to create a new message.
+ */
+export const DeleteSavedQueryRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 12);
+
+/**
+ * Describes the message bytebase.v1.SearchSavedQueriesRequest.
+ * Use `create(SearchSavedQueriesRequestSchema)` to create a new message.
+ */
+export const SearchSavedQueriesRequestSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 13);
+
+/**
+ * Describes the message bytebase.v1.SearchSavedQueriesResponse.
+ * Use `create(SearchSavedQueriesResponseSchema)` to create a new message.
+ */
+export const SearchSavedQueriesResponseSchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 14);
+
+/**
+ * Describes the message bytebase.v1.SavedQuery.
+ * Use `create(SavedQuerySchema)` to create a new message.
+ */
+export const SavedQuerySchema = /*@__PURE__*/
+ messageDesc(file_v1_saved_query_service, 15);
+
+/**
+ * Describes the enum bytebase.v1.SavedQuery.Visibility.
+ */
+export const SavedQuery_VisibilitySchema = /*@__PURE__*/
+ enumDesc(file_v1_saved_query_service, 15, 0);
+
+/**
+ * @generated from enum bytebase.v1.SavedQuery.Visibility
+ */
+export const SavedQuery_Visibility = /*@__PURE__*/
+ tsEnum(SavedQuery_VisibilitySchema);
+
+/**
+ * SavedQueryService manages saved queries for SQL Editor query development.
+ * Permission IDs still use the legacy `bb.worksheets.*` names; they are
+ * renamed together with the access-model redesign and its role migration.
+ *
+ * @generated from service bytebase.v1.SavedQueryService
+ */
+export const SavedQueryService = /*@__PURE__*/
+ serviceDesc(file_v1_saved_query_service, 0);
+
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
deleted file mode 100644
index 7422ea7fe4..0000000000
--- a/frontend/src/types/proto-es/v1/worksheet_service_pb.d.ts
+++ /dev/null
@@ -1,771 +0,0 @@
-// @generated by protoc-gen-es v2.12.0
-// @generated from file v1/worksheet_service.proto (package bytebase.v1, syntax proto3)
-/* eslint-disable */
-
-import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
-import type { Message } from "@bufbuild/protobuf";
-import type { EmptySchema, FieldMask, Timestamp } from "@bufbuild/protobuf/wkt";
-
-/**
- * Describes the file v1/worksheet_service.proto.
- */
-export declare const file_v1_worksheet_service: GenFile;
-
-/**
- * @generated from message bytebase.v1.CreateWorksheetRequest
- */
-export declare type CreateWorksheetRequest = Message<"bytebase.v1.CreateWorksheetRequest"> & {
- /**
- * The parent resource where this worksheet will be created.
- * Format: projects/{project}
- *
- * @generated from field: string parent = 1;
- */
- parent: string;
-
- /**
- * The worksheet to create.
- *
- * @generated from field: bytebase.v1.Worksheet worksheet = 2;
- */
- worksheet?: Worksheet | undefined;
-};
-
-/**
- * Describes the message bytebase.v1.CreateWorksheetRequest.
- * Use `create(CreateWorksheetRequestSchema)` to create a new message.
- */
-export declare const CreateWorksheetRequestSchema: GenMessage<CreateWorksheetRequest>;
-
-/**
- * @generated from message bytebase.v1.GetWorksheetRequest
- */
-export declare type GetWorksheetRequest = Message<"bytebase.v1.GetWorksheetRequest"> & {
- /**
- * The name of the worksheet to retrieve.
- * Format: projects/{project}/worksheets/{worksheet}
- *
- * @generated from field: string name = 1;
- */
- name: string;
-};
-
-/**
- * Describes the message bytebase.v1.GetWorksheetRequest.
- * Use `create(GetWorksheetRequestSchema)` to create a new message.
- */
-export declare const GetWorksheetRequestSchema: GenMessage<GetWorksheetRequest>;
-
-/**
- * @generated from message bytebase.v1.ListWorksheetsRequest
- */
-export declare type ListWorksheetsRequest = Message<"bytebase.v1.ListWorksheetsRequest"> & {
- /**
- * The parent resource of the worksheets.
- * Format: projects/{project}
- * Use "projects/-" to list worksheets across all projects.
- *
- * @generated from field: string parent = 1;
- */
- parent: string;
-
- /**
- * To filter the list result.
- * The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- *
- * Supported filter:
- * - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- *
- * For example:
- * creator == "users/{email}"
- * creator != "users/{email}"
- *
- * @generated from field: string filter = 2;
- */
- filter: string;
-
- /**
- * The maximum number of worksheets to return. The service may return fewer than
- * this value.
- * If unspecified, at most 10 worksheets will be returned.
- * The maximum value is 1000; values above 1000 will be coerced to 1000.
- *
- * @generated from field: int32 page_size = 3;
- */
- pageSize: number;
-
- /**
- * A page token, received from a previous `ListWorksheets` call.
- * Provide this to retrieve the subsequent page.
- *
- * When paginating, all other parameters provided to `ListWorksheets` must match
- * the call that provided the page token.
- *
- * @generated from field: string page_token = 4;
- */
- pageToken: string;
-};
-
-/**
- * Describes the message bytebase.v1.ListWorksheetsRequest.
- * Use `create(ListWorksheetsRequestSchema)` to create a new message.
- */
-export declare const ListWorksheetsRequestSchema: GenMessage<ListWorksheetsRequest>;
-
-/**
- * @generated from message bytebase.v1.ListWorksheetsResponse
- */
-export declare type ListWorksheetsResponse = Message<"bytebase.v1.ListWorksheetsResponse"> & {
- /**
- * The worksheets from the specified parent.
- *
- * @generated from field: repeated bytebase.v1.Worksheet worksheets = 1;
- */
- worksheets: Worksheet[];
-
- /**
- * A token to retrieve next page of worksheets.
- * Pass this value in the page_token field in the subsequent call to
- * `ListWorksheets` method to retrieve the next page of worksheets.
- *
- * @generated from field: string next_page_token = 2;
- */
- nextPageToken: string;
-};
-
-/**
- * Describes the message bytebase.v1.ListWorksheetsResponse.
- * Use `create(ListWorksheetsResponseSchema)` to create a new message.
- */
-export declare const ListWorksheetsResponseSchema: GenMessage<ListWorksheetsResponse>;
-
-/**
- * @generated from message bytebase.v1.ListWorksheetFoldersRequest
- */
-export declare type ListWorksheetFoldersRequest = Message<"bytebase.v1.ListWorksheetFoldersRequest"> & {
- /**
- * The parent resource of the worksheet folders.
- * Format: projects/{project}
- *
- * @generated from field: string parent = 1;
- */
- parent: string;
-};
-
-/**
- * Describes the message bytebase.v1.ListWorksheetFoldersRequest.
- * Use `create(ListWorksheetFoldersRequestSchema)` to create a new message.
- */
-export declare const ListWorksheetFoldersRequestSchema: GenMessage<ListWorksheetFoldersRequest>;
-
-/**
- * @generated from message bytebase.v1.ListWorksheetFoldersResponse
- */
-export declare type ListWorksheetFoldersResponse = Message<"bytebase.v1.ListWorksheetFoldersResponse"> & {
- /**
- * The caller's worksheet folders.
- *
- * @generated from field: repeated bytebase.v1.WorksheetFolder folders = 1;
- */
- folders: WorksheetFolder[];
-};
-
-/**
- * Describes the message bytebase.v1.ListWorksheetFoldersResponse.
- * Use `create(ListWorksheetFoldersResponseSchema)` to create a new message.
- */
-export declare const ListWorksheetFoldersResponseSchema: GenMessage<ListWorksheetFoldersResponse>;
-
-/**
- * @generated from message bytebase.v1.WorksheetFolder
- */
-export declare type WorksheetFolder = Message<"bytebase.v1.WorksheetFolder"> & {
- /**
- * The folder path segments.
- *
- * @generated from field: repeated string folders = 1;
- */
- folders: string[];
-
- /**
- * The folder category.
- *
- * @generated from field: bytebase.v1.WorksheetFolder.Category category = 2;
- */
- category: WorksheetFolder_Category;
-};
-
-/**
- * Describes the message bytebase.v1.WorksheetFolder.
- * Use `create(WorksheetFolderSchema)` to create a new message.
- */
-export declare const WorksheetFolderSchema: GenMessage<WorksheetFolder>;
-
-/**
- * @generated from enum bytebase.v1.WorksheetFolder.Category
- */
-export enum WorksheetFolder_Category {
- /**
- * @generated from enum value: CATEGORY_UNSPECIFIED = 0;
- */
- CATEGORY_UNSPECIFIED = 0,
-
- /**
- * @generated from enum value: MINE = 1;
- */
- MINE = 1,
-
- /**
- * @generated from enum value: SHARED = 2;
- */
- SHARED = 2,
-}
-
-/**
- * Describes the enum bytebase.v1.WorksheetFolder.Category.
- */
-export declare const WorksheetFolder_CategorySchema: GenEnum<WorksheetFolder_Category>;
-
-/**
- * @generated from message bytebase.v1.UpdateWorksheetRequest
- */
-export declare type UpdateWorksheetRequest = Message<"bytebase.v1.UpdateWorksheetRequest"> & {
- /**
- * The worksheet to update.
- *
- * The worksheet's `name` field is used to identify the worksheet to update.
- * Format: projects/{project}/worksheets/{worksheet}
- *
- * @generated from field: bytebase.v1.Worksheet worksheet = 1;
- */
- worksheet?: Worksheet | undefined;
-
- /**
- * The list of fields to be updated.
- * Fields are specified relative to the worksheet.
- * (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)
- * Only support update the following fields for now:
- * - `title`
- * - `statement`
- * - `starred`
- * - `visibility`
- *
- * @generated from field: google.protobuf.FieldMask update_mask = 2;
- */
- updateMask?: FieldMask | undefined;
-};
-
-/**
- * Describes the message bytebase.v1.UpdateWorksheetRequest.
- * Use `create(UpdateWorksheetRequestSchema)` to create a new message.
- */
-export declare const UpdateWorksheetRequestSchema: GenMessage<UpdateWorksheetRequest>;
-
-/**
- * @generated from message bytebase.v1.BatchUpdateWorksheetOrganizerRequest
- */
-export declare type BatchUpdateWorksheetOrganizerRequest = Message<"bytebase.v1.BatchUpdateWorksheetOrganizerRequest"> & {
- /**
- * The parent resource whose worksheets' organizers are updated.
- * Format: projects/{project}
- *
- * @generated from field: string parent = 1;
- */
- parent: string;
-
- /**
- * To filter the batch update target.
- * The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- *
- * Supported filter:
- * - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- * - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- * - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- * - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- * - folder: the worksheet organizer folder path, support exact "==" operator.
- *
- * @generated from field: string filter = 2;
- */
- filter: string;
-
- /**
- * The organizer fields to update.
- *
- * @generated from field: bytebase.v1.WorksheetOrganizer organizer = 3;
- */
- organizer?: WorksheetOrganizer | undefined;
-
- /**
- * The list of fields to be updated.
- * Fields are specified relative to the worksheet organizer.
- * Only support update the following fields for now:
- * - `starred`
- * - `folders`
- *
- * @generated from field: google.protobuf.FieldMask update_mask = 4;
- */
- updateMask?: FieldMask | undefined;
-};
-
-/**
- * Describes the message bytebase.v1.BatchUpdateWorksheetOrganizerRequest.
- * Use `create(BatchUpdateWorksheetOrganizerRequestSchema)` to create a new message.
- */
-export declare const BatchUpdateWorksheetOrganizerRequestSchema: GenMessage<BatchUpdateWorksheetOrganizerRequest>;
-
-/**
- * @generated from message bytebase.v1.BatchUpdateWorksheetOrganizerResponse
- */
-export declare type BatchUpdateWorksheetOrganizerResponse = Message<"bytebase.v1.BatchUpdateWorksheetOrganizerResponse"> & {
- /**
- * @generated from field: repeated bytebase.v1.WorksheetOrganizer worksheet_organizers = 1;
- */
- worksheetOrganizers: WorksheetOrganizer[];
-
- /**
- * @generated from field: int32 updated_count = 2;
- */
- updatedCount: number;
-};
-
-/**
- * Describes the message bytebase.v1.BatchUpdateWorksheetOrganizerResponse.
- * Use `create(BatchUpdateWorksheetOrganizerResponseSchema)` to create a new message.
- */
-export declare const BatchUpdateWorksheetOrganizerResponseSchema: GenMessage<BatchUpdateWorksheetOrganizerResponse>;
-
-/**
- * @generated from message bytebase.v1.UpdateWorksheetOrganizerRequest
- */
-export declare type UpdateWorksheetOrganizerRequest = Message<"bytebase.v1.UpdateWorksheetOrganizerRequest"> & {
- /**
- * The organizer to update.
- *
- * The organizer's `worksheet` field is used to identify the worksheet.
- * Format: projects/{project}/worksheets/{worksheet}
- *
- * @generated from field: bytebase.v1.WorksheetOrganizer organizer = 1;
- */
- organizer?: WorksheetOrganizer | undefined;
-
- /**
- * The list of fields to be updated.
- * Fields are specified relative to the worksheet organizer.
- * Only support update the following fields for now:
- * - `starred`
- *
- * @generated from field: google.protobuf.FieldMask update_mask = 2;
- */
- updateMask?: FieldMask | undefined;
-
- /**
- * If set to true, and the worksheet organizer is not found, a new worksheet organizer will be created.
- * In this situation, `update_mask` is ignored.
- *
- * @generated from field: bool allow_missing = 3;
- */
- allowMissing: boolean;
-};
-
-/**
- * Describes the message bytebase.v1.UpdateWorksheetOrganizerRequest.
- * Use `create(UpdateWorksheetOrganizerRequestSchema)` to create a new message.
- */
-export declare const UpdateWorksheetOrganizerRequestSchema: GenMessage<UpdateWorksheetOrganizerRequest>;
-
-/**
- * @generated from message bytebase.v1.WorksheetOrganizer
- */
-export declare type WorksheetOrganizer = Message<"bytebase.v1.WorksheetOrganizer"> & {
- /**
- * The name of the worksheet.
- * Format: projects/{project}/worksheets/{worksheet}
- *
- * @generated from field: string worksheet = 1;
- */
- worksheet: string;
-
- /**
- * starred means if the worksheet is starred.
- *
- * @generated from field: bool starred = 2;
- */
- starred: boolean;
-
- /**
- * @generated from field: repeated string folders = 3;
- */
- folders: string[];
-};
-
-/**
- * Describes the message bytebase.v1.WorksheetOrganizer.
- * Use `create(WorksheetOrganizerSchema)` to create a new message.
- */
-export declare const WorksheetOrganizerSchema: GenMessage<WorksheetOrganizer>;
-
-/**
- * @generated from message bytebase.v1.DeleteWorksheetRequest
- */
-export declare type DeleteWorksheetRequest = Message<"bytebase.v1.DeleteWorksheetRequest"> & {
- /**
- * The name of the worksheet to delete.
- * Format: projects/{project}/worksheets/{worksheet}
- *
- * @generated from field: string name = 1;
- */
- name: string;
-};
-
-/**
- * Describes the message bytebase.v1.DeleteWorksheetRequest.
- * Use `create(DeleteWorksheetRequestSchema)` to create a new message.
- */
-export declare const DeleteWorksheetRequestSchema: GenMessage<DeleteWorksheetRequest>;
-
-/**
- * @generated from message bytebase.v1.SearchWorksheetsRequest
- */
-export declare type SearchWorksheetsRequest = Message<"bytebase.v1.SearchWorksheetsRequest"> & {
- /**
- * The parent resource of the worksheets.
- * Format: projects/{project}
- *
- * @generated from field: string parent = 1;
- */
- parent: string;
-
- /**
- * To filter the search result.
- * The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- *
- * Supported filter:
- * - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- * - title: the worksheet title, support "contains" operator.
- * - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- * - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- * - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- * - folder: the worksheet organizer folder path, support "==" operator.
- *
- * For example:
- * creator == "users/{email}"
- * title.contains("worksheet title")
- * creator != "users/{email}"
- * starred == true
- * starred == false
- * visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
- * visibility == "PRIVATE"
- * folder == "foo/bar"
- *
- * @generated from field: string filter = 2;
- */
- filter: string;
-
- /**
- * The maximum number of worksheets to return. The service may return fewer than
- * this value.
- * If unspecified, at most 10 worksheets will be returned.
- * The maximum value is 1000; values above 1000 will be coerced to 1000.
- *
- * @generated from field: int32 page_size = 3;
- */
- pageSize: number;
-
- /**
- * A page token, received from a previous `SearchWorksheets` call.
- * Provide this to retrieve the subsequent page.
- *
- * @generated from field: string page_token = 4;
- */
- pageToken: string;
-};
-
-/**
- * Describes the message bytebase.v1.SearchWorksheetsRequest.
- * Use `create(SearchWorksheetsRequestSchema)` to create a new message.
- */
-export declare const SearchWorksheetsRequestSchema: GenMessage<SearchWorksheetsRequest>;
-
-/**
- * @generated from message bytebase.v1.SearchWorksheetsResponse
- */
-export declare type SearchWorksheetsResponse = Message<"bytebase.v1.SearchWorksheetsResponse"> & {
- /**
- * The worksheets that matched the search criteria.
- *
- * @generated from field: repeated bytebase.v1.Worksheet worksheets = 1;
- */
- worksheets: Worksheet[];
-
- /**
- * A token to retrieve next page of worksheets.
- * Pass this value in the page_token field in the subsequent call to
- * `SearchWorksheets` method to retrieve the next page of worksheets.
- *
- * @generated from field: string next_page_token = 2;
- */
- nextPageToken: string;
-};
-
-/**
- * Describes the message bytebase.v1.SearchWorksheetsResponse.
- * Use `create(SearchWorksheetsResponseSchema)` to create a new message.
- */
-export declare const SearchWorksheetsResponseSchema: GenMessage<SearchWorksheetsResponse>;
-
-/**
- * @generated from message bytebase.v1.Worksheet
- */
-export declare type Worksheet = Message<"bytebase.v1.Worksheet"> & {
- /**
- * The name of the worksheet resource, generated by the server.
- * Canonical parent is project.
- * Format: projects/{project}/worksheets/{worksheet}
- *
- * @generated from field: string name = 1;
- */
- name: string;
-
- /**
- * The project resource name.
- * Format: projects/{project}
- *
- * @generated from field: string project = 2;
- */
- project: string;
-
- /**
- * The database resource name.
- * Format: instances/{instance}/databases/{database}
- * If the database parent doesn't exist, the database field is empty.
- *
- * @generated from field: string database = 3;
- */
- database: string;
-
- /**
- * The title of the worksheet.
- *
- * @generated from field: string title = 4;
- */
- title: string;
-
- /**
- * The creator of the Worksheet.
- * Format: users/{email}
- *
- * @generated from field: string creator = 5;
- */
- creator: string;
-
- /**
- * The create time of the worksheet.
- *
- * @generated from field: google.protobuf.Timestamp create_time = 6;
- */
- createTime?: Timestamp | undefined;
-
- /**
- * The last update time of the worksheet.
- *
- * @generated from field: google.protobuf.Timestamp update_time = 7;
- */
- updateTime?: Timestamp | undefined;
-
- /**
- * The content of the worksheet.
- * By default, it will be cut off in SearchWorksheet() method. If it doesn't match the `content_size`, you can
- * use GetWorksheet() request to retrieve the full content.
- *
- * @generated from field: bytes content = 8;
- */
- content: Uint8Array;
-
- /**
- * content_size is the full size of the content, may not match the size of the `content` field.
- *
- * @generated from field: int64 content_size = 9;
- */
- contentSize: bigint;
-
- /**
- * @generated from field: bytebase.v1.Worksheet.Visibility visibility = 10;
- */
- visibility: Worksheet_Visibility;
-
- /**
- * starred indicates whether the worksheet is starred by the current authenticated user.
- *
- * @generated from field: bool starred = 11;
- */
- starred: boolean;
-
- /**
- * @generated from field: repeated string folders = 12;
- */
- folders: string[];
-};
-
-/**
- * Describes the message bytebase.v1.Worksheet.
- * Use `create(WorksheetSchema)` to create a new message.
- */
-export declare const WorksheetSchema: GenMessage<Worksheet>;
-
-/**
- * @generated from enum bytebase.v1.Worksheet.Visibility
- */
-export enum Worksheet_Visibility {
- /**
- * @generated from enum value: VISIBILITY_UNSPECIFIED = 0;
- */
- VISIBILITY_UNSPECIFIED = 0,
-
- /**
- * Read access in project scope, worksheet OWNER/DBA and project OWNER can read/write, other project members can read.
- *
- * @generated from enum value: PROJECT_READ = 1;
- */
- PROJECT_READ = 1,
-
- /**
- * Write access in project scope, worksheet OWNER/DBA and all members in the project can write the worksheet.
- *
- * @generated from enum value: PROJECT_WRITE = 2;
- */
- PROJECT_WRITE = 2,
-
- /**
- * Private, only worksheet OWNER can read/write.
- *
- * @generated from enum value: PRIVATE = 3;
- */
- PRIVATE = 3,
-}
-
-/**
- * Describes the enum bytebase.v1.Worksheet.Visibility.
- */
-export declare const Worksheet_VisibilitySchema: GenEnum<Worksheet_Visibility>;
-
-/**
- * WorksheetService manages SQL worksheets for query development.
- *
- * @generated from service bytebase.v1.WorksheetService
- */
-export declare const WorksheetService: GenService<{
- /**
- * Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
- * Permissions required: None (authenticated users only)
- *
- * @generated from rpc bytebase.v1.WorksheetService.CreateWorksheet
- */
- createWorksheet: {
- methodKind: "unary";
- input: typeof CreateWorksheetRequestSchema;
- output: typeof WorksheetSchema;
- },
- /**
- * Get a worksheet by name.
- * The users can access this method if,
- * - they are the creator of the worksheet;
- * - they have bb.worksheets.get permission on the workspace;
- * - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- * Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- *
- * @generated from rpc bytebase.v1.WorksheetService.GetWorksheet
- */
- getWorksheet: {
- methodKind: "unary";
- input: typeof GetWorksheetRequestSchema;
- output: typeof WorksheetSchema;
- },
- /**
- * List worksheets.
- * This is used for listing worksheets in a project, or across all projects by using `projects/-`.
- * Permissions required: bb.worksheets.list
- *
- * @generated from rpc bytebase.v1.WorksheetService.ListWorksheets
- */
- listWorksheets: {
- methodKind: "unary";
- input: typeof ListWorksheetsRequestSchema;
- output: typeof ListWorksheetsResponseSchema;
- },
- /**
- * List the caller's worksheet folders.
- * Only folders stored in the caller's worksheet organizer are returned.
- *
- * @generated from rpc bytebase.v1.WorksheetService.ListWorksheetFolders
- */
- listWorksheetFolders: {
- methodKind: "unary";
- input: typeof ListWorksheetFoldersRequestSchema;
- output: typeof ListWorksheetFoldersResponseSchema;
- },
- /**
- * Search for worksheets.
- * This is used for finding my worksheets or worksheets shared by other people.
- * The sheet accessibility is the same as GetWorksheet().
- * Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- *
- * @generated from rpc bytebase.v1.WorksheetService.SearchWorksheets
- */
- searchWorksheets: {
- methodKind: "unary";
- input: typeof SearchWorksheetsRequestSchema;
- output: typeof SearchWorksheetsResponseSchema;
- },
- /**
- * Update a worksheet.
- * The users can access this method if,
- * - they are the creator of the worksheet;
- * - they have bb.worksheets.manage permission on the workspace;
- * - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- * Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- *
- * @generated from rpc bytebase.v1.WorksheetService.UpdateWorksheet
- */
- updateWorksheet: {
- methodKind: "unary";
- input: typeof UpdateWorksheetRequestSchema;
- output: typeof WorksheetSchema;
- },
- /**
- * Update the organizer of a worksheet.
- * The access is the same as UpdateWorksheet method.
- * Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- *
- * @generated from rpc bytebase.v1.WorksheetService.UpdateWorksheetOrganizer
- */
- updateWorksheetOrganizer: {
- methodKind: "unary";
- input: typeof UpdateWorksheetOrganizerRequestSchema;
- output: typeof WorksheetOrganizerSchema;
- },
- /**
- * Batch update the organizers of worksheets.
- * The access is the same as UpdateWorksheet method.
- * Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- *
- * @generated from rpc bytebase.v1.WorksheetService.BatchUpdateWorksheetOrganizer
- */
- batchUpdateWorksheetOrganizer: {
- methodKind: "unary";
- input: typeof BatchUpdateWorksheetOrganizerRequestSchema;
- output: typeof BatchUpdateWorksheetOrganizerResponseSchema;
- },
- /**
- * Delete a worksheet.
- * The access is the same as UpdateWorksheet method.
- * Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- *
- * @generated from rpc bytebase.v1.WorksheetService.DeleteWorksheet
- */
- deleteWorksheet: {
- methodKind: "unary";
- input: typeof DeleteWorksheetRequestSchema;
- output: typeof EmptySchema;
- },
-}>;
-
diff --git a/frontend/src/types/proto-es/v1/worksheet_service_pb.js b/frontend/src/types/proto-es/v1/worksheet_service_pb.js
deleted file mode 100644
index 83acbb34d2..0000000000
--- a/frontend/src/types/proto-es/v1/worksheet_service_pb.js
+++ /dev/null
@@ -1,163 +0,0 @@
-// @generated by protoc-gen-es v2.12.0
-// @generated from file v1/worksheet_service.proto (package bytebase.v1, syntax proto3)
-/* eslint-disable */
-
-import { enumDesc, fileDesc, messageDesc, serviceDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
-import { file_buf_validate_validate } from "../buf/validate/validate_pb";
-import { file_google_api_annotations } from "../google/api/annotations_pb";
-import { file_google_api_client } from "../google/api/client_pb";
-import { file_google_api_field_behavior } from "../google/api/field_behavior_pb";
-import { file_google_api_resource } from "../google/api/resource_pb";
-import { file_google_protobuf_empty, file_google_protobuf_field_mask, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
-import { file_v1_annotation } from "./annotation_pb";
-
-/**
- * Describes the file v1/worksheet_service.proto.
- */
-export const file_v1_worksheet_service = /*@__PURE__*/
- fileDesc("Chp2MS93b3Jrc2hlZXRfc2VydmljZS5wcm90bxILYnl0ZWJhc2UudjEiXQoWQ3JlYXRlV29ya3NoZWV0UmVxdWVzdBITCgZwYXJlbnQYASABKAlCA+BBAhIuCgl3b3Jrc2hlZXQYAiABKAsyFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRCA+BBAiIoChNHZXRXb3Jrc2hlZXRSZXF1ZXN0EhEKBG5hbWUYASABKAlCA+BBAiJ8ChVMaXN0V29ya3NoZWV0c1JlcXVlc3QSLAoGcGFyZW50GAEgASgJQhzgQQL6QRYKFGJ5dGViYXNlLmNvbS9Qcm9qZWN0Eg4KBmZpbHRlchgCIAEoCRIRCglwYWdlX3NpemUYAyABKAUSEgoKcGFnZV90b2tlbhgEIAEoCSJdChZMaXN0V29ya3NoZWV0c1Jlc3BvbnNlEioKCndvcmtzaGVldHMYASADKAsyFi5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQSFwoPbmV4dF9wYWdlX3Rva2VuGAIgASgJIjIKG0xpc3RXb3Jrc2hlZXRGb2xkZXJzUmVxdWVzdBITCgZwYXJlbnQYASABKAlCA+BBAiJNChxMaXN0V29ya3NoZWV0Rm9sZGVyc1Jlc3BvbnNlEi0KB2ZvbGRlcnMYASADKAsyHC5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRGb2xkZXIilwEKD1dvcmtzaGVldEZvbGRlchIPCgdmb2xkZXJzGAEgAygJEjcKCGNhdGVnb3J5GAIgASgOMiUuYnl0ZWJhc2UudjEuV29ya3NoZWV0Rm9sZGVyLkNhdGVnb3J5IjoKCENhdGVnb3J5EhgKFENBVEVHT1JZX1VOU1BFQ0lGSUVEEAASCAoETUlORRABEgoKBlNIQVJFRBACInkKFlVwZGF0ZVdvcmtzaGVldFJlcXVlc3QSLgoJd29ya3NoZWV0GAEgASgLMhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0QgPgQQISLwoLdXBkYXRlX21hc2sYAiABKAsyGi5nb29nbGUucHJvdG9idWYuRmllbGRNYXNrIroBCiRCYXRjaFVwZGF0ZVdvcmtzaGVldE9yZ2FuaXplclJlcXVlc3QSEwoGcGFyZW50GAEgASgJQgPgQQISDgoGZmlsdGVyGAIgASgJEjcKCW9yZ2FuaXplchgDIAEoCzIfLmJ5dGViYXNlLnYxLldvcmtzaGVldE9yZ2FuaXplckID4EECEjQKC3VwZGF0ZV9tYXNrGAQgASgLMhouZ29vZ2xlLnByb3RvYnVmLkZpZWxkTWFza0ID4EECIn0KJUJhdGNoVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVzcG9uc2USPQoUd29ya3NoZWV0X29yZ2FuaXplcnMYASADKAsyHy5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRPcmdhbml6ZXISFQoNdXBkYXRlZF9jb3VudBgCIAEoBSKiAQofVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVxdWVzdBI3Cglvcmdhbml6ZXIYASABKAsyHy5ieXRlYmFzZS52MS5Xb3Jrc2hlZXRPcmdhbml6ZXJCA+BBAhIvCgt1cGRhdGVfbWFzaxgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5GaWVsZE1hc2sSFQoNYWxsb3dfbWlzc2luZxgDIAEoCCJOChJXb3Jrc2hlZXRPcmdhbml6ZXISFgoJd29ya3NoZWV0GAEgASgJQgPgQQISDwoHc3RhcnJlZBgCIAEoCBIPCgdmb2xkZXJzGAMgAygJIisKFkRlbGV0ZVdvcmtzaGVldFJlcXVlc3QSEQoEbmFtZRgBIAEoCUID4EECImUKF1NlYXJjaFdvcmtzaGVldHNSZXF1ZXN0EhMKBnBhcmVudBgBIAEoCUID4EECEg4KBmZpbHRlchgCIAEoCRIRCglwYWdlX3NpemUYAyABKAUSEgoKcGFnZV90b2tlbhgEIAEoCSJfChhTZWFyY2hXb3Jrc2hlZXRzUmVzcG9uc2USKgoKd29ya3NoZWV0cxgBIAMoCzIWLmJ5dGViYXNlLnYxLldvcmtzaGVldBIXCg9uZXh0X3BhZ2VfdG9rZW4YAiABKAki3AMKCVdvcmtzaGVldBIUCgRuYW1lGAEgASgJQgbgQQLgQQUSFAoHcHJvamVjdBgCIAEoCUID4EEDEhAKCGRhdGFiYXNlGAMgASgJEhoKBXRpdGxlGAQgASgJQgvgQQK6SAVyAxjIARIUCgdjcmVhdG9yGAUgASgJQgPgQQMSNAoLY3JlYXRlX3RpbWUYBiABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wQgPgQQMSNAoLdXBkYXRlX3RpbWUYByABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wQgPgQQMSFAoHY29udGVudBgIIAEoDEID4EECEhkKDGNvbnRlbnRfc2l6ZRgJIAEoA0ID4EEDEjoKCnZpc2liaWxpdHkYCiABKA4yIS5ieXRlYmFzZS52MS5Xb3Jrc2hlZXQuVmlzaWJpbGl0eUID4EECEhQKB3N0YXJyZWQYCyABKAhCA+BBAxIUCgdmb2xkZXJzGAwgAygJQgPgQQMiWgoKVmlzaWJpbGl0eRIaChZWSVNJQklMSVRZX1VOU1BFQ0lGSUVEEAASEAoMUFJPSkVDVF9SRUFEEAESEQoNUFJPSkVDVF9XUklURRACEgsKB1BSSVZBVEUQAzKvDAoQV29ya3NoZWV0U2VydmljZRKcAQoPQ3JlYXRlV29ya3NoZWV0EiMuYnl0ZWJhc2UudjEuQ3JlYXRlV29ya3NoZWV0UmVxdWVzdBoWLmJ5dGViYXNlLnYxLldvcmtzaGVldCJM2kEQcGFyZW50LHdvcmtzaGVldJDqMAKC0+STAi86CXdvcmtzaGVldCIiL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vd29ya3NoZWV0cxJ/CgxHZXRXb3Jrc2hlZXQSIC5ieXRlYmFzZS52MS5HZXRXb3Jrc2hlZXRSZXF1ZXN0GhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0IjXaQQRuYW1lkOowAoLT5JMCJBIiL3YxL3tuYW1lPXByb2plY3RzLyovd29ya3NoZWV0cy8qfRKoAQoOTGlzdFdvcmtzaGVldHMSIi5ieXRlYmFzZS52MS5MaXN0V29ya3NoZWV0c1JlcXVlc3QaIy5ieXRlYmFzZS52MS5MaXN0V29ya3NoZWV0c1Jlc3BvbnNlIk3aQQZwYXJlbnSK6jASYmIud29ya3NoZWV0cy5saXN0kOowAYLT5JMCJBIiL3YxL3twYXJlbnQ9cHJvamVjdHMvKn0vd29ya3NoZWV0cxKqAQoUTGlzdFdvcmtzaGVldEZvbGRlcnMSKC5ieXRlYmFzZS52MS5MaXN0V29ya3NoZWV0Rm9sZGVyc1JlcXVlc3QaKS5ieXRlYmFzZS52MS5MaXN0V29ya3NoZWV0Rm9sZGVyc1Jlc3BvbnNlIj3aQQZwYXJlbnSQ6jACgtPkkwIqEigvdjEve3BhcmVudD1wcm9qZWN0cy8qfS93b3Jrc2hlZXRGb2xkZXJzEqIBChBTZWFyY2hXb3Jrc2hlZXRzEiQuYnl0ZWJhc2UudjEuU2VhcmNoV29ya3NoZWV0c1JlcXVlc3QaJS5ieXRlYmFzZS52MS5TZWFyY2hXb3Jrc2hlZXRzUmVzcG9uc2UiQdpBBnBhcmVudJDqMAKC0+STAi46ASoiKS92MS97cGFyZW50PXByb2plY3RzLyp9L3dvcmtzaGVldHM6c2VhcmNoEqsBCg9VcGRhdGVXb3Jrc2hlZXQSIy5ieXRlYmFzZS52MS5VcGRhdGVXb3Jrc2hlZXRSZXF1ZXN0GhYuYnl0ZWJhc2UudjEuV29ya3NoZWV0IlvaQRV3b3Jrc2hlZXQsdXBkYXRlX21hc2uQ6jACgtPkkwI5Ogl3b3Jrc2hlZXQyLC92MS97d29ya3NoZWV0Lm5hbWU9cHJvamVjdHMvKi93b3Jrc2hlZXRzLyp9EtUBChhVcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXISLC5ieXRlYmFzZS52MS5VcGRhdGVXb3Jrc2hlZXRPcmdhbml6ZXJSZXF1ZXN0Gh8uYnl0ZWJhc2UudjEuV29ya3NoZWV0T3JnYW5pemVyImraQRVvcmdhbml6ZXIsdXBkYXRlX21hc2uQ6jACgtPkkwJIOglvcmdhbml6ZXIyOy92MS97b3JnYW5pemVyLndvcmtzaGVldD1wcm9qZWN0cy8qL3dvcmtzaGVldHMvKn0vb3JnYW5pemVyEu8BCh1CYXRjaFVwZGF0ZVdvcmtzaGVldE9yZ2FuaXplchIxLmJ5dGViYXNlLnYxLkJhdGNoVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVxdWVzdBoyLmJ5dGViYXNlLnYxLkJhdGNoVXBkYXRlV29ya3NoZWV0T3JnYW5pemVyUmVzcG9uc2UiZ9pBHHBhcmVudCxvcmdhbml6ZXIsdXBkYXRlX21hc2uQ6jACgtPkkwI+OgEqIjkvdjEve3BhcmVudD1wcm9qZWN0cy8qfS93b3Jrc2hlZXRzL29yZ2FuaXplcnM6YmF0Y2hVcGRhdGUShQEKD0RlbGV0ZVdvcmtzaGVldBIjLmJ5dGViYXNlLnYxLkRlbGV0ZVdvcmtzaGVldFJlcXVlc3QaFi5nb29nbGUucHJvdG9idWYuRW1wdHkiNdpBBG5hbWWQ6jACgtPkkwIkKiIvdjEve25hbWU9cHJvamVjdHMvKi93b3Jrc2hlZXRzLyp9QqsBCg9jb20uYnl0ZWJhc2UudjFCFVdvcmtzaGVldFNlcnZpY2VQcm90b1ABWjRnaXRodWIuY29tL2J5dGViYXNlL2J5dGViYXNlL2JhY2tlbmQvZ2VuZXJhdGVkLWdvL3YxogIDQlhYqgILQnl0ZWJhc2UuVjHKAgtCeXRlYmFzZVxWMeICF0J5dGViYXNlXFYxXEdQQk1ldGFkYXRh6gIMQnl0ZWJhc2U6OlYxYgZwcm90bzM", [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.CreateWorksheetRequest.
- * Use `create(CreateWorksheetRequestSchema)` to create a new message.
- */
-export const CreateWorksheetRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 0);
-
-/**
- * Describes the message bytebase.v1.GetWorksheetRequest.
- * Use `create(GetWorksheetRequestSchema)` to create a new message.
- */
-export const GetWorksheetRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 1);
-
-/**
- * Describes the message bytebase.v1.ListWorksheetsRequest.
- * Use `create(ListWorksheetsRequestSchema)` to create a new message.
- */
-export const ListWorksheetsRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 2);
-
-/**
- * Describes the message bytebase.v1.ListWorksheetsResponse.
- * Use `create(ListWorksheetsResponseSchema)` to create a new message.
- */
-export const ListWorksheetsResponseSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 3);
-
-/**
- * Describes the message bytebase.v1.ListWorksheetFoldersRequest.
- * Use `create(ListWorksheetFoldersRequestSchema)` to create a new message.
- */
-export const ListWorksheetFoldersRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 4);
-
-/**
- * Describes the message bytebase.v1.ListWorksheetFoldersResponse.
- * Use `create(ListWorksheetFoldersResponseSchema)` to create a new message.
- */
-export const ListWorksheetFoldersResponseSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 5);
-
-/**
- * Describes the message bytebase.v1.WorksheetFolder.
- * Use `create(WorksheetFolderSchema)` to create a new message.
- */
-export const WorksheetFolderSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 6);
-
-/**
- * Describes the enum bytebase.v1.WorksheetFolder.Category.
- */
-export const WorksheetFolder_CategorySchema = /*@__PURE__*/
- enumDesc(file_v1_worksheet_service, 6, 0);
-
-/**
- * @generated from enum bytebase.v1.WorksheetFolder.Category
- */
-export const WorksheetFolder_Category = /*@__PURE__*/
- tsEnum(WorksheetFolder_CategorySchema);
-
-/**
- * Describes the message bytebase.v1.UpdateWorksheetRequest.
- * Use `create(UpdateWorksheetRequestSchema)` to create a new message.
- */
-export const UpdateWorksheetRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 7);
-
-/**
- * Describes the message bytebase.v1.BatchUpdateWorksheetOrganizerRequest.
- * Use `create(BatchUpdateWorksheetOrganizerRequestSchema)` to create a new message.
- */
-export const BatchUpdateWorksheetOrganizerRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 8);
-
-/**
- * Describes the message bytebase.v1.BatchUpdateWorksheetOrganizerResponse.
- * Use `create(BatchUpdateWorksheetOrganizerResponseSchema)` to create a new message.
- */
-export const BatchUpdateWorksheetOrganizerResponseSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 9);
-
-/**
- * Describes the message bytebase.v1.UpdateWorksheetOrganizerRequest.
- * Use `create(UpdateWorksheetOrganizerRequestSchema)` to create a new message.
- */
-export const UpdateWorksheetOrganizerRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 10);
-
-/**
- * Describes the message bytebase.v1.WorksheetOrganizer.
- * Use `create(WorksheetOrganizerSchema)` to create a new message.
- */
-export const WorksheetOrganizerSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 11);
-
-/**
- * Describes the message bytebase.v1.DeleteWorksheetRequest.
- * Use `create(DeleteWorksheetRequestSchema)` to create a new message.
- */
-export const DeleteWorksheetRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 12);
-
-/**
- * Describes the message bytebase.v1.SearchWorksheetsRequest.
- * Use `create(SearchWorksheetsRequestSchema)` to create a new message.
- */
-export const SearchWorksheetsRequestSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 13);
-
-/**
- * Describes the message bytebase.v1.SearchWorksheetsResponse.
- * Use `create(SearchWorksheetsResponseSchema)` to create a new message.
- */
-export const SearchWorksheetsResponseSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 14);
-
-/**
- * Describes the message bytebase.v1.Worksheet.
- * Use `create(WorksheetSchema)` to create a new message.
- */
-export const WorksheetSchema = /*@__PURE__*/
- messageDesc(file_v1_worksheet_service, 15);
-
-/**
- * Describes the enum bytebase.v1.Worksheet.Visibility.
- */
-export const Worksheet_VisibilitySchema = /*@__PURE__*/
- enumDesc(file_v1_worksheet_service, 15, 0);
-
-/**
- * @generated from enum bytebase.v1.Worksheet.Visibility
- */
-export const Worksheet_Visibility = /*@__PURE__*/
- tsEnum(Worksheet_VisibilitySchema);
-
-/**
- * WorksheetService manages SQL worksheets for query development.
- *
- * @generated from service bytebase.v1.WorksheetService
- */
-export const WorksheetService = /*@__PURE__*/
- serviceDesc(file_v1_worksheet_service, 0);
-
diff --git a/frontend/src/types/sqlEditor/tab.ts b/frontend/src/types/sqlEditor/tab.ts
index bd586e3eae..095bf0518c 100644
--- a/frontend/src/types/sqlEditor/tab.ts
+++ b/frontend/src/types/sqlEditor/tab.ts
@@ -10,8 +10,8 @@ export type SQLEditorTabStatus =
| "SAVING" // auto-saving in progress
| "CLEAN"; // saved to a remote sheet
-export type SQLEditorTabMode = "WORKSHEET" | "ADMIN";
-export const DEFAULT_SQL_EDITOR_TAB_MODE: SQLEditorTabMode = "WORKSHEET";
+export type SQLEditorTabMode = "SAVED_QUERY" | "ADMIN";
+export const DEFAULT_SQL_EDITOR_TAB_MODE: SQLEditorTabMode = "SAVED_QUERY";
export type QueryDataSourceType =
| DataSourceType.ADMIN
| DataSourceType.READ_ONLY;
@@ -66,7 +66,7 @@ export type SQLEditorTab = {
// basic fields
id: string; // uuid
title: string; // display title, should be synced with sheet's title once saved
- worksheet: string; // if ref to a local or remote sheet
+ savedQuery: string; // if ref to a local or remote sheet
connection: SQLEditorConnection;
status: SQLEditorTabStatus;
statement: string; // local editing statement, might be out-of-sync to ref sheet's statement
@@ -94,5 +94,5 @@ export type SQLEditorTab = {
export type CoreSQLEditorTab = Pick<
SQLEditorTab,
- "worksheet" | "connection" | "mode"
+ "savedQuery" | "connection" | "mode"
>;
diff --git a/frontend/src/utils/index.ts b/frontend/src/utils/index.ts
index 18194da805..435f5393ae 100644
--- a/frontend/src/utils/index.ts
+++ b/frontend/src/utils/index.ts
@@ -27,6 +27,7 @@ export * from "./auto-route";
export * from "./pagination";
export * from "./expr";
export * from "./accessGrant";
+export * from "./legacy-paths";
export * from "./storage-keys";
export * from "./storage-migrate";
export * from "./document-title";
diff --git a/frontend/src/utils/legacy-paths.test.ts b/frontend/src/utils/legacy-paths.test.ts
new file mode 100644
index 0000000000..6ea2ae8722
--- /dev/null
+++ b/frontend/src/utils/legacy-paths.test.ts
@@ -0,0 +1,37 @@
+import { describe, expect, test } from "vitest";
+import { rewriteLegacyPath } from "./legacy-paths";
+
+const setPath = (path: string) => {
+ window.history.replaceState(null, "", path);
+};
+
+describe("rewriteLegacyPath", () => {
+ test("rewrites a legacy sheet deep link, keeping query and hash", () => {
+ setPath("/sql-editor/projects/p1/sheets/abc-123?schema=public#frag");
+ rewriteLegacyPath();
+ expect(
+ window.location.pathname + window.location.search + window.location.hash
+ ).toBe("/sql-editor/projects/p1/savedQueries/abc-123?schema=public#frag");
+ });
+
+ test("tolerates a trailing slash", () => {
+ setPath("/sql-editor/projects/p1/sheets/abc/");
+ rewriteLegacyPath();
+ expect(window.location.pathname).toBe(
+ "/sql-editor/projects/p1/savedQueries/abc"
+ );
+ });
+
+ test("leaves current and unrelated paths alone", () => {
+ for (const path of [
+ "/sql-editor/projects/p1/savedQueries/abc",
+ "/sql-editor/projects/p1/instances/i1/databases/db1",
+ "/projects/p1/sheets/abc",
+ "/sql-editor",
+ ]) {
+ setPath(path);
+ rewriteLegacyPath();
+ expect(window.location.pathname).toBe(path);
+ }
+ });
+});
diff --git a/frontend/src/utils/legacy-paths.ts b/frontend/src/utils/legacy-paths.ts
new file mode 100644
index 0000000000..926800cbe8
--- /dev/null
+++ b/frontend/src/utils/legacy-paths.ts
@@ -0,0 +1,18 @@
+// One-time URL rewrite for renamed routes, run before the router mounts.
+// Deep links from before the worksheet → saved query rename used
+// `/sql-editor/projects/{project}/sheets/{sheet}`; bookmarks and shared
+// links land as full page loads, so rewriting here (history.replaceState)
+// covers every real entry point and lets the SQL Editor bootstrap read the
+// current route shape only.
+const LEGACY_SHEET_PATH =
+ /^(\/sql-editor\/projects\/[^/]+)\/sheets\/([^/]+)\/?$/;
+
+export function rewriteLegacyPath() {
+ const match = LEGACY_SHEET_PATH.exec(window.location.pathname);
+ if (!match) return;
+ window.history.replaceState(
+ window.history.state,
+ "",
+ `${match[1]}/savedQueries/${match[2]}${window.location.search}${window.location.hash}`
+ );
+}
diff --git a/frontend/src/utils/migrate-user-storage.test.ts b/frontend/src/utils/migrate-user-storage.test.ts
index 71d9ff16e2..3f24689075 100644
--- a/frontend/src/utils/migrate-user-storage.test.ts
+++ b/frontend/src/utils/migrate-user-storage.test.ts
@@ -160,15 +160,15 @@ describe("migrateUserStorage", () => {
localStorage.setItem(`bb.sql-editor.conn-expanded.env/prod.${email}`, "12");
localStorage.setItem(`bb.sql-editor.conn-expanded-keys.${email}`, "13");
localStorage.setItem(
- `bb.sql-editor.worksheet-filter.projects/p1.${email}`,
+ `bb.sql-editor.saved-query-filter.projects/p1.${email}`,
"14"
);
localStorage.setItem(
- `bb.sql-editor.worksheet-tree.projects/p1.${email}`,
+ `bb.sql-editor.saved-query-tree.projects/p1.${email}`,
"15"
);
localStorage.setItem(
- `bb.sql-editor.worksheet-folder.projects/p1.list.${email}`,
+ `bb.sql-editor.saved-query-folder.projects/p1.list.${email}`,
"16"
);
localStorage.setItem(`bb.sql-editor.ai-suggestion.${email}`, "17");
@@ -199,17 +199,17 @@ describe("migrateUserStorage", () => {
).toBe("13");
expect(
localStorage.getItem(
- `bb.sql-editor.worksheet-filter.projects/p1.${newEmail}`
+ `bb.sql-editor.saved-query-filter.projects/p1.${newEmail}`
)
).toBe("14");
expect(
localStorage.getItem(
- `bb.sql-editor.worksheet-tree.projects/p1.${newEmail}`
+ `bb.sql-editor.saved-query-tree.projects/p1.${newEmail}`
)
).toBe("15");
expect(
localStorage.getItem(
- `bb.sql-editor.worksheet-folder.projects/p1.list.${newEmail}`
+ `bb.sql-editor.saved-query-folder.projects/p1.list.${newEmail}`
)
).toBe("16");
expect(
diff --git a/frontend/src/utils/sqlEditor.ts b/frontend/src/utils/sqlEditor.ts
index db4218423a..7569aac8a0 100644
--- a/frontend/src/utils/sqlEditor.ts
+++ b/frontend/src/utils/sqlEditor.ts
@@ -10,7 +10,7 @@ export const defaultSQLEditorTab = (): SQLEditorTab => {
return {
id: uuidv1(),
// Tabs are created untitled. The UI renders a localized "Untitled"
- // placeholder when the title is empty; users name worksheets explicitly
+ // placeholder when the title is empty; users name saved queries explicitly
// when (and if) they save.
title: "",
connection: emptySQLEditorConnection(),
@@ -18,7 +18,7 @@ export const defaultSQLEditorTab = (): SQLEditorTab => {
selectedStatement: "",
status: "CLEAN",
mode: DEFAULT_SQL_EDITOR_TAB_MODE,
- worksheet: "",
+ savedQuery: "",
treeState: {
database: UNKNOWN_DATABASE_NAME,
keys: [],
diff --git a/frontend/src/utils/storage-keys.ts b/frontend/src/utils/storage-keys.ts
index 7544ae77e4..c908d3da43 100644
--- a/frontend/src/utils/storage-keys.ts
+++ b/frontend/src/utils/storage-keys.ts
@@ -88,23 +88,29 @@ export const storageKeySqlEditorConnExpanded = (
) => withScope("bb.sql-editor.conn-expanded", scope, env, email);
export const storageKeySqlEditorShowMissingQueryDb = (email: string) =>
`bb.sql-editor.show-missing-query-db.${email}`;
-export const storageKeySqlEditorWorksheetFilter = (
+export const storageKeySqlEditorSavedQueryFilter = (
scope: string,
project: string,
email: string
-) => withScope("bb.sql-editor.worksheet-filter", scope, project, email);
-export const storageKeySqlEditorWorksheetTree = (
+) => withScope("bb.sql-editor.saved-query-filter", scope, project, email);
+export const storageKeySqlEditorSavedQueryTree = (
scope: string,
project: string,
email: string
-) => withScope("bb.sql-editor.worksheet-tree", scope, project, email);
-export const storageKeySqlEditorWorksheetFolder = (
+) => withScope("bb.sql-editor.saved-query-tree", scope, project, email);
+export const storageKeySqlEditorSavedQueryFolder = (
scope: string,
project: string,
viewMode: string,
email: string
) =>
- withScope("bb.sql-editor.worksheet-folder", scope, project, viewMode, email);
+ withScope(
+ "bb.sql-editor.saved-query-folder",
+ scope,
+ project,
+ viewMode,
+ email
+ );
export const storageKeySqlEditorAiSuggestion = (email: string) =>
`bb.sql-editor.ai-suggestion.${email}`;
diff --git a/frontend/src/utils/storage-migrate.test.ts b/frontend/src/utils/storage-migrate.test.ts
index 745f2b91f0..fca964b801 100644
--- a/frontend/src/utils/storage-migrate.test.ts
+++ b/frontend/src/utils/storage-migrate.test.ts
@@ -262,19 +262,26 @@ describe("SQL editor migrations", () => {
describe("tab keys (opening-tab-list and current-tab-id)", () => {
test("migrates opening-tab-list to bb.sql-editor.tabs.*", () => {
const tabs = JSON.stringify([
- { id: "tab-1", worksheet: "worksheets/ws-1" },
- { id: "tab-2", worksheet: "worksheets/ws-2" },
+ { id: "tab-1", worksheet: "projects/my-proj/worksheets/ws-1" },
+ { id: "tab-2", worksheet: "projects/my-proj/worksheets/ws-2" },
]);
localStorage.setItem(
"bb.sql-editor-tab.projects/[email protected]",
tabs
);
migrateStorageKeys();
+ // The v2 stage renames the legacy `worksheet` link field and its name
+ // format in the same pass.
expect(
localStorage.getItem(
"bb.sql-editor.tabs.projects/[email protected]"
)
- ).toBe(tabs);
+ ).toBe(
+ JSON.stringify([
+ { id: "tab-1", savedQuery: "projects/my-proj/savedQueries/ws-1" },
+ { id: "tab-2", savedQuery: "projects/my-proj/savedQueries/ws-2" },
+ ])
+ );
expect(
localStorage.getItem(
"bb.sql-editor-tab.projects/[email protected]"
@@ -302,8 +309,8 @@ describe("SQL editor migrations", () => {
test("migrates both tab list and current tab together", () => {
const tabs = JSON.stringify([
- { id: "tab-a", worksheet: "worksheets/ws-a" },
- { id: "tab-b", worksheet: "worksheets/ws-b" },
+ { id: "tab-a", worksheet: "projects/p1/worksheets/ws-a" },
+ { id: "tab-b", worksheet: "projects/p1/worksheets/ws-b" },
]);
localStorage.setItem(
"bb.sql-editor-tab.projects/[email protected]",
@@ -316,7 +323,12 @@ describe("SQL editor migrations", () => {
migrateStorageKeys();
expect(
localStorage.getItem("bb.sql-editor.tabs.projects/[email protected]")
- ).toBe(tabs);
+ ).toBe(
+ JSON.stringify([
+ { id: "tab-a", savedQuery: "projects/p1/savedQueries/ws-a" },
+ { id: "tab-b", savedQuery: "projects/p1/savedQueries/ws-b" },
+ ])
+ );
expect(
localStorage.getItem("bb.sql-editor.current-tab.projects/[email protected]")
).toBe('"tab-b"');
@@ -562,7 +574,7 @@ describe("full migration scenario", () => {
test("handles empty localStorage gracefully", () => {
migrateStorageKeys();
expect(localStorage.getItem(MIGRATION_MARKER)).toBe("1");
- expect(localStorage.length).toBe(1); // only the marker
+ expect(localStorage.length).toBe(2); // only the v1 and v2 markers
});
test("preserves unrelated keys", () => {
@@ -572,3 +584,134 @@ describe("full migration scenario", () => {
expect(localStorage.getItem("some.other.key")).toBe("value");
});
});
+
+describe("v2: worksheet → saved query rename", () => {
+ const MARKER_V2 = "bb.storage-migration-v2";
+
+ test("moves saved-query pref keys, preserving values and scope segments", () => {
+ localStorage.setItem(
+ "bb.sql-editor.worksheet-filter.projects/[email protected]",
+ '{"mine":true}'
+ );
+ localStorage.setItem(
+ "bb.sql-editor.worksheet-tree.ws1.projects/[email protected]",
+ '["k1"]'
+ );
+ localStorage.setItem(
+ "bb.sql-editor.worksheet-folder.projects/[email protected]",
+ '["f1"]'
+ );
+ migrateStorageKeys();
+ expect(
+ localStorage.getItem(
+ "bb.sql-editor.saved-query-filter.projects/[email protected]"
+ )
+ ).toBe('{"mine":true}');
+ expect(
+ localStorage.getItem(
+ "bb.sql-editor.saved-query-tree.ws1.projects/[email protected]"
+ )
+ ).toBe('["k1"]');
+ expect(
+ localStorage.getItem(
+ "bb.sql-editor.saved-query-folder.projects/[email protected]"
+ )
+ ).toBe('["f1"]');
+ expect(
+ localStorage.getItem("bb.sql-editor.worksheet-filter.projects/[email protected]")
+ ).toBeNull();
+ expect(localStorage.getItem(MARKER_V2)).toBe("1");
+ });
+
+ test("does not overwrite an existing saved-query pref key", () => {
+ localStorage.setItem(
+ "bb.sql-editor.worksheet-filter.projects/[email protected]",
+ "old"
+ );
+ localStorage.setItem(
+ "bb.sql-editor.saved-query-filter.projects/[email protected]",
+ "new"
+ );
+ migrateStorageKeys();
+ expect(
+ localStorage.getItem(
+ "bb.sql-editor.saved-query-filter.projects/[email protected]"
+ )
+ ).toBe("new");
+ });
+
+ test("rewrites persisted tabs already under the current key", () => {
+ // Users upgraded past v1 have tabs at the new key with legacy fields.
+ localStorage.setItem(MIGRATION_MARKER, "1");
+ localStorage.setItem(
+ "bb.sql-editor.tabs.projects/[email protected]",
+ JSON.stringify([
+ {
+ id: "t1",
+ worksheet: "projects/p1/worksheets/ws-1",
+ mode: "WORKSHEET",
+ },
+ {
+ id: "t2",
+ savedQuery: "projects/p1/savedQueries/ws-2",
+ mode: "ADMIN",
+ },
+ { id: "t3" },
+ ])
+ );
+ migrateStorageKeys();
+ expect(localStorage.getItem("bb.sql-editor.tabs.projects/[email protected]")).toBe(
+ JSON.stringify([
+ {
+ id: "t1",
+ savedQuery: "projects/p1/savedQueries/ws-1",
+ mode: "SAVED_QUERY",
+ },
+ {
+ id: "t2",
+ savedQuery: "projects/p1/savedQueries/ws-2",
+ mode: "ADMIN",
+ },
+ { id: "t3" },
+ ])
+ );
+ });
+
+ test("leaves malformed tab values alone", () => {
+ localStorage.setItem("bb.sql-editor.tabs.projects/[email protected]", "not-json");
+ migrateStorageKeys();
+ expect(localStorage.getItem("bb.sql-editor.tabs.projects/[email protected]")).toBe(
+ "not-json"
+ );
+ });
+
+ test("maps the persisted sidebar tab value", () => {
+ localStorage.setItem(
+ "bb.sql-editor.sidebar.last-visited-tab.projects/p1",
+ '"WORKSHEET"'
+ );
+ localStorage.setItem(
+ "bb.sql-editor.sidebar.last-visited-tab.projects/p2",
+ '"SCHEMA"'
+ );
+ migrateStorageKeys();
+ expect(
+ localStorage.getItem("bb.sql-editor.sidebar.last-visited-tab.projects/p1")
+ ).toBe('"SAVED_QUERY"');
+ expect(
+ localStorage.getItem("bb.sql-editor.sidebar.last-visited-tab.projects/p2")
+ ).toBe('"SCHEMA"');
+ });
+
+ test("skips when the v2 marker is set", () => {
+ localStorage.setItem(MARKER_V2, "1");
+ localStorage.setItem(
+ "bb.sql-editor.worksheet-filter.projects/[email protected]",
+ "old"
+ );
+ migrateStorageKeys();
+ expect(
+ localStorage.getItem("bb.sql-editor.worksheet-filter.projects/[email protected]")
+ ).toBe("old");
+ });
+});
diff --git a/frontend/src/utils/storage-migrate.ts b/frontend/src/utils/storage-migrate.ts
index d0a82ca834..34bb468ec3 100644
--- a/frontend/src/utils/storage-migrate.ts
+++ b/frontend/src/utils/storage-migrate.ts
@@ -14,6 +14,9 @@ import {
} from "./storage-keys";
const MIGRATION_MARKER = "bb.storage-migration-v1";
+// v2: worksheet → saved query rename (2026-08). Runs after v1 so Vue-era
+// keys are already at their post-v1 names before values are rewritten.
+const MIGRATION_MARKER_V2 = "bb.storage-migration-v2";
// Static key renames: [oldKey, newKey]
const STATIC_KEY_RENAMES: [string, string][] = [
@@ -170,21 +173,118 @@ function migrateSqlEditorConnKeys() {
}
}
+// Pref keys renamed by the worksheet → saved query rename; values move over
+// unchanged.
+const SAVED_QUERY_PREFIX_RENAMES: [string, string][] = [
+ ["bb.sql-editor.worksheet-filter.", "bb.sql-editor.saved-query-filter."],
+ ["bb.sql-editor.worksheet-tree.", "bb.sql-editor.saved-query-tree."],
+ ["bb.sql-editor.worksheet-folder.", "bb.sql-editor.saved-query-folder."],
+];
+
+function migrateSavedQueryPrefixKeys() {
+ for (const [oldPrefix, newPrefix] of SAVED_QUERY_PREFIX_RENAMES) {
+ const keysToMigrate: [string, string][] = [];
+ for (let i = 0; i < localStorage.length; i++) {
+ const key = localStorage.key(i);
+ if (key?.startsWith(oldPrefix)) {
+ keysToMigrate.push([key, `${newPrefix}${key.slice(oldPrefix.length)}`]);
+ }
+ }
+ for (const [oldKey, newKey] of keysToMigrate) {
+ moveKey(oldKey, newKey);
+ }
+ }
+}
+
+function migrateSavedQueryTabValues() {
+ // Persisted tab entries carried the saved-query link under `worksheet`
+ // (old name format `projects/*/worksheets/*`) and mode "WORKSHEET".
+ // `normalizePersistedTab` in the tab store maps these lazily as well;
+ // this rewrite keeps stored data in the current shape.
+ const TABS_PREFIX = "bb.sql-editor.tabs.";
+ const keys: string[] = [];
+ for (let i = 0; i < localStorage.length; i++) {
+ const key = localStorage.key(i);
+ if (key?.startsWith(TABS_PREFIX)) {
+ keys.push(key);
+ }
+ }
+ for (const key of keys) {
+ const raw = localStorage.getItem(key);
+ if (!raw) continue;
+ try {
+ const tabs: unknown = JSON.parse(raw);
+ if (!Array.isArray(tabs)) continue;
+ const migrated = tabs.map((tab) => {
+ if (!tab || typeof tab !== "object") return tab;
+ const { worksheet, savedQuery, mode, ...rest } = tab as Record<
+ string,
+ unknown
+ >;
+ const next: Record<string, unknown> = { ...rest };
+ if (typeof worksheet === "string" || typeof savedQuery === "string") {
+ let name = "";
+ if (typeof savedQuery === "string" && savedQuery) {
+ name = savedQuery;
+ } else if (typeof worksheet === "string") {
+ name = worksheet;
+ }
+ next.savedQuery = name.replace("/worksheets/", "/savedQueries/");
+ }
+ if (mode !== undefined) {
+ next.mode = mode === "WORKSHEET" ? "SAVED_QUERY" : mode;
+ }
+ return next;
+ });
+ localStorage.setItem(key, JSON.stringify(migrated));
+ } catch {
+ // Leave malformed values alone; the tab store tolerates them.
+ }
+ }
+}
+
+function migrateSavedQuerySidebarTabValues() {
+ // The aside-panel tab value is a JSON-encoded string; "WORKSHEET" became
+ // "SAVED_QUERY".
+ const PREFIX = "bb.sql-editor.sidebar.last-visited-tab";
+ const keys: string[] = [];
+ for (let i = 0; i < localStorage.length; i++) {
+ const key = localStorage.key(i);
+ if (key === PREFIX || key?.startsWith(`${PREFIX}.`)) {
+ keys.push(key);
+ }
+ }
+ for (const key of keys) {
+ if (localStorage.getItem(key) === '"WORKSHEET"') {
+ localStorage.setItem(key, '"SAVED_QUERY"');
+ }
+ }
+}
+
/**
- * Run all localStorage key migrations. Idempotent — skips if already done.
- * Must be called before any store or composable reads from localStorage.
+ * Run all localStorage key migrations. Idempotent — each stage skips if
+ * already done. Must be called before any store or composable reads from
+ * localStorage.
*/
export function migrateStorageKeys() {
- if (localStorage.getItem(MIGRATION_MARKER)) return;
+ if (!localStorage.getItem(MIGRATION_MARKER)) {
+ migrateLanguage();
+ migrateStaticKeys();
+ migratePrefixKeys();
+ migrateUIScopeKeys();
+ migrateSqlEditorTabKeys();
+ migrateSqlEditorConnKeys();
+
+ localStorage.setItem(MIGRATION_MARKER, "1");
+ }
- migrateLanguage();
- migrateStaticKeys();
- migratePrefixKeys();
- migrateUIScopeKeys();
- migrateSqlEditorTabKeys();
- migrateSqlEditorConnKeys();
+ if (!localStorage.getItem(MIGRATION_MARKER_V2)) {
+ migrateSavedQueryPrefixKeys();
+ migrateSavedQueryTabValues();
+ migrateSavedQuerySidebarTabValues();
- localStorage.setItem(MIGRATION_MARKER, "1");
+ localStorage.setItem(MIGRATION_MARKER_V2, "1");
+ }
}
/**
diff --git a/frontend/src/utils/v1/index.ts b/frontend/src/utils/v1/index.ts
index c68bf8a4ac..f17822126a 100644
--- a/frontend/src/utils/v1/index.ts
+++ b/frontend/src/utils/v1/index.ts
@@ -9,7 +9,7 @@ export * from "./user";
export * from "./instance";
export * from "./sql";
export * from "./sheet";
-export * from "./worksheet";
+export * from "./savedQuery";
export * from "./queryHistory";
export * from "./issue";
export * from "./changelog";
diff --git a/frontend/src/utils/v1/worksheet.ts b/frontend/src/utils/v1/savedQuery.ts
similarity index 72%
rename from frontend/src/utils/v1/worksheet.ts
rename to frontend/src/utils/v1/savedQuery.ts
index 2823252291..fdc629f51a 100644
--- a/frontend/src/utils/v1/worksheet.ts
+++ b/frontend/src/utils/v1/savedQuery.ts
@@ -2,13 +2,13 @@ import { getCurrentUserV1 } from "@/stores";
import { getProjectByName } from "@/stores/app/projectAccess";
import { extractUserEmail } from "@/stores/modules/v1/common";
import { UNKNOWN_ID, UNKNOWN_PROJECT_NAME } from "@/types";
-import type { Worksheet } from "@/types/proto-es/v1/worksheet_service_pb";
-import { Worksheet_Visibility } from "@/types/proto-es/v1/worksheet_service_pb";
+import type { SavedQuery } from "@/types/proto-es/v1/saved_query_service_pb";
+import { SavedQuery_Visibility } from "@/types/proto-es/v1/saved_query_service_pb";
import { hasProjectPermissionV2, hasWorkspacePermissionV2 } from "@/utils";
-export const extractWorksheetID = (name: string) => {
- const pattern = /(?:^|\/)worksheets\/([^/]+)(?:$|\/)/;
- const matches = name.match(pattern);
+export const extractSavedQueryID = (name: string) => {
+ const pattern = /(?:^|\/)savedQueries\/([^/]+)(?:$|\/)/;
+ const matches = pattern.exec(name);
return matches?.[1] ?? `${UNKNOWN_ID}`;
};
@@ -16,7 +16,7 @@ export const extractWorksheetID = (name: string) => {
// PRIVATE: workspace Owner/DBA and the creator only.
// PROJECT_WRITE: workspace Owner/DBA and all members in the project.
// PROJECT_READ: workspace Owner/DBA and all members in the project.
-export const isWorksheetReadableV1 = (sheet: Worksheet) => {
+export const isSavedQueryReadableV1 = (sheet: SavedQuery) => {
const currentUser = getCurrentUserV1();
if (extractUserEmail(sheet.creator) === currentUser.email) {
@@ -29,10 +29,10 @@ export const isWorksheetReadableV1 = (sheet: Worksheet) => {
}
switch (sheet.visibility) {
- case Worksheet_Visibility.PRIVATE:
+ case SavedQuery_Visibility.PRIVATE:
return false;
- case Worksheet_Visibility.PROJECT_READ:
- case Worksheet_Visibility.PROJECT_WRITE: {
+ case SavedQuery_Visibility.PROJECT_READ:
+ case SavedQuery_Visibility.PROJECT_WRITE: {
const projectV1 = getProjectByName(sheet.project);
if (projectV1.name === UNKNOWN_PROJECT_NAME) {
return false;
@@ -47,7 +47,7 @@ export const isWorksheetReadableV1 = (sheet: Worksheet) => {
// PRIVATE: workspace Owner/DBA and the creator only.
// PROJECT_WRITE: workspace Owner/DBA and all members in the project.
// PROJECT_READ: workspace Owner/DBA and project owner.
-export const isWorksheetWritableV1 = (sheet: Worksheet) => {
+export const isSavedQueryWritableV1 = (sheet: SavedQuery) => {
const currentUser = getCurrentUserV1();
if (extractUserEmail(sheet.creator) === currentUser.email) {
@@ -64,18 +64,18 @@ export const isWorksheetWritableV1 = (sheet: Worksheet) => {
return false;
}
switch (sheet.visibility) {
- case Worksheet_Visibility.PRIVATE:
+ case SavedQuery_Visibility.PRIVATE:
return false;
- case Worksheet_Visibility.PROJECT_WRITE:
+ case SavedQuery_Visibility.PROJECT_WRITE:
return hasProjectPermissionV2(projectV1, "bb.projects.get");
- case Worksheet_Visibility.PROJECT_READ:
+ case SavedQuery_Visibility.PROJECT_READ:
return hasProjectPermissionV2(projectV1, "bb.worksheets.manage");
}
return false;
};
-// `extractWorksheetConnection` moved to `@/lib/sqlEditorConnection`
+// `extractSavedQueryConnection` moved to `@/lib/sqlEditorConnection`
// so the database lookup can go through the React app store without
// dragging `@/stores/app` into the `@/utils` import graph (which
// would create a static ESM cycle).
diff --git a/frontend/src/utils/v1/sheet.ts b/frontend/src/utils/v1/sheet.ts
index bb3bdf4d40..fc6cb3dbd2 100644
--- a/frontend/src/utils/v1/sheet.ts
+++ b/frontend/src/utils/v1/sheet.ts
@@ -1,5 +1,5 @@
+import type { SavedQuery } from "@/types/proto-es/v1/saved_query_service_pb";
import type { Sheet } from "@/types/proto-es/v1/sheet_service_pb";
-import type { Worksheet } from "@/types/proto-es/v1/worksheet_service_pb";
export const extractSheetUID = (name: string) => {
const pattern = /(?:^|\/)sheets\/([^/]+)(?:$|\/)/;
@@ -8,19 +8,19 @@ export const extractSheetUID = (name: string) => {
};
export const setSheetStatement = (
- sheet: Sheet | Worksheet,
+ sheet: Sheet | SavedQuery,
statement: string
) => {
sheet.content = new TextEncoder().encode(statement);
sheet.contentSize = BigInt(new TextEncoder().encode(statement).length);
};
-export const getSheetStatement = (sheet: Sheet | Worksheet) => {
+export const getSheetStatement = (sheet: Sheet | SavedQuery) => {
return new TextDecoder().decode(sheet.content);
};
// Whether the sheet carries its full content rather than a truncated preview
// (fetches without `raw` return at most a size-capped prefix). `content` is
// already the encoded bytes, so this is an O(1) size check.
-export const isSheetContentComplete = (sheet: Sheet | Worksheet): boolean =>
+export const isSheetContentComplete = (sheet: Sheet | SavedQuery): boolean =>
BigInt(sheet.content.byteLength) >= sheet.contentSize;
diff --git a/frontend/tests/e2e/AGENTS.md b/frontend/tests/e2e/AGENTS.md
index e6cb4b4296..f9f976db49 100644
--- a/frontend/tests/e2e/AGENTS.md
+++ b/frontend/tests/e2e/AGENTS.md
@@ -307,7 +307,7 @@ moving on.
banners, confirm-dialog titles — read them one by one. Duplicate wording (a field
labeled "Expiration" with a "4 hours" dropdown that *also* says "hours" inline),
backwards version banners ("New version 3.17.1 available" while you're on 3.18),
-and placebo confirm dialogs ("Confirm to delete this worksheet?" with no body
+and placebo confirm dialogs ("Delete this saved query?" with no body
text) all hide in plain text we breeze past.
#### 10. Record video for transient bugs
@@ -460,7 +460,7 @@ If the test still passes, it isn't actually checking the thing.
#### L. Self-contained state
No test depends on another's leftovers. Every spec sets up and tears down its
-own DB schema, worksheets, IAM bindings. Independence is the only way tests
+own DB schema, saved queries, IAM bindings. Independence is the only way tests
survive at scale.
#### M. Assert visual relationships, not absolute thresholds
diff --git a/frontend/tests/e2e/README.md b/frontend/tests/e2e/README.md
index c049f0ad64..2bf4f50722 100644
--- a/frontend/tests/e2e/README.md
+++ b/frontend/tests/e2e/README.md
@@ -105,7 +105,7 @@ frontend/tests/e2e/
│ ├── seed-test-data.ts — workspace-level baseline seeded once per boot
│ ├── sign-in.ts — POST-login helper that captures per-user storageState
│ └── psql.ts — psql-over-Unix-socket helpers for DDL/DML setup
-├── sql-editor/ — SQL Editor suite (connection, result, tabs, worksheet,
+├── sql-editor/ — SQL Editor suite (connection, result, tabs, saved query,
│ schema, admin-mode, history, jit, permissions,
│ workspace-gates, batch, misc) + sql-editor.page.ts
├── plan-detail/ — plan detail suite (lifecycle, checks, rollout, sections, tasks)
diff --git a/frontend/tests/e2e/framework/api-client.ts b/frontend/tests/e2e/framework/api-client.ts
index 96e90500d9..61bae96fa5 100644
--- a/frontend/tests/e2e/framework/api-client.ts
+++ b/frontend/tests/e2e/framework/api-client.ts
@@ -490,19 +490,19 @@ export class BytebaseApiClient {
return resp.name;
}
- // Worksheets — distinct from Sheets. SQL Editor's left sidebar tree shows
- // Worksheets, identified by `projects/{project}/worksheets/{uuid}`. The
- // UUID portion is what the editor URL takes (`/sheets/{uuid}` confusingly
- // routes to a worksheet).
- async createWorksheet(project: string, title: string, database: string, content: string): Promise<{ name: string }> {
+ // SavedQueries — distinct from Sheets. SQL Editor's left sidebar tree shows
+ // SavedQueries, identified by `projects/{project}/savedQueries/{uuid}`. The
+ // UUID portion is what the editor URL takes (`/savedQueries/{uuid}`
+ // routes to a saved query).
+ async createSavedQuery(project: string, title: string, database: string, content: string): Promise<{ name: string }> {
const b64 = Buffer.from(content).toString("base64");
return this.request<{ name: string }>(
- "POST", `/v1/${project}/worksheets`,
+ "POST", `/v1/${project}/savedQueries`,
{ title, database, content: b64, visibility: "PRIVATE" },
);
}
- async deleteWorksheet(name: string): Promise<void> {
+ async deleteSavedQuery(name: string): Promise<void> {
try { await this.request<unknown>("DELETE", `/v1/${name}`); } catch { /* ignore */ }
}
diff --git a/frontend/tests/e2e/framework/seed-test-data.ts b/frontend/tests/e2e/framework/seed-test-data.ts
index 96622b96f6..a0f5a76103 100644
--- a/frontend/tests/e2e/framework/seed-test-data.ts
+++ b/frontend/tests/e2e/framework/seed-test-data.ts
@@ -21,7 +21,7 @@ const TEST_EXTERNAL_URL = "https://e2e.bytebase.test";
*
* Specifically does NOT:
* - Create extra projects (would change the SQL editor's default
- * landing project; see the worksheet specs that gotoHome() and
+ * landing project; see the saved query specs that gotoHome() and
* expect to land on `project-sample`).
* - Flip per-project feature flags (allowRequestRole,
* allowJustInTimeAccess) — those are SUT for individual specs.
diff --git a/frontend/tests/e2e/framework/setup-project.ts b/frontend/tests/e2e/framework/setup-project.ts
index f59657ffa6..825c391fca 100644
--- a/frontend/tests/e2e/framework/setup-project.ts
+++ b/frontend/tests/e2e/framework/setup-project.ts
@@ -78,7 +78,7 @@ setup("authenticate and discover", async ({ page }) => {
// `head(projects)` from a list sorted by created_time DESC. Any spec
// that creates an additional project (e.g. connection.spec.ts's
// project-switcher fixture) would silently shift the default project
- // for every later spec, breaking gotoHome-based worksheet/sidebar
+ // for every later spec, breaking gotoHome-based saved query/sidebar
// tests that assume `project-sample`. Visiting the URL exercises the
// real `setProject()` path which writes to localStorage in whatever
// shape `useLocalStorage` expects — safer than hand-rolling the JSON
diff --git a/frontend/tests/e2e/sql-editor/sql-editor-access-grants.spec.ts b/frontend/tests/e2e/sql-editor/sql-editor-access-grants.spec.ts
index f835a4169f..143cc980bb 100644
--- a/frontend/tests/e2e/sql-editor/sql-editor-access-grants.spec.ts
+++ b/frontend/tests/e2e/sql-editor/sql-editor-access-grants.spec.ts
@@ -146,12 +146,12 @@ test.afterAll(async () => {
// L6 + H1 — the ACCESS gutter tab only renders when the project has
// `allowJustInTimeAccess` enabled, so the gutter count flips between
-// 3 (Worksheet/Schema/History) and 4 (+ Access).
+// 3 (SavedQuery/Schema/History) and 4 (+ Access).
test.describe("ACCESS gutter tab follows the project's allowJustInTimeAccess flag", () => {
test("with JIT off, the gutter has 3 tabs and no Access tab", async () => {
await setJIT(false);
- await expect(viewerEditor.gutterWorksheetTab).toBeVisible({ timeout: 10_000 });
+ await expect(viewerEditor.gutterSavedQueryTab).toBeVisible({ timeout: 10_000 });
await expect(viewerEditor.gutterSchemaTab).toBeVisible();
await expect(viewerEditor.gutterHistoryTab).toBeVisible();
// ACCESS tab is conditionally rendered — must be absent here.
@@ -161,7 +161,7 @@ test.describe("ACCESS gutter tab follows the project's allowJustInTimeAccess fla
test("with JIT on, the gutter exposes an ACCESS tab in addition to the 3 defaults", async () => {
await setJIT(true);
- await expect(viewerEditor.gutterWorksheetTab).toBeVisible({ timeout: 10_000 });
+ await expect(viewerEditor.gutterSavedQueryTab).toBeVisible({ timeout: 10_000 });
await expect(viewerEditor.gutterSchemaTab).toBeVisible();
await expect(viewerEditor.gutterHistoryTab).toBeVisible();
await expect(viewerEditor.gutterAccessTab).toBeVisible();
diff --git a/frontend/tests/e2e/sql-editor/sql-editor-admin-mode.spec.ts b/frontend/tests/e2e/sql-editor/sql-editor-admin-mode.spec.ts
index aa19b25100..8863027084 100644
--- a/frontend/tests/e2e/sql-editor/sql-editor-admin-mode.spec.ts
+++ b/frontend/tests/e2e/sql-editor/sql-editor-admin-mode.spec.ts
@@ -3,7 +3,7 @@
// Covers the admin-mode toggle (the wrench button) and the dark-theme
// terminal it opens: visibility/disabled state of the wrench, entering
// admin mode, executing a query in the terminal, exiting back to the
-// worksheet, and the result panel's theme harmony (BYT-9496 lock).
+// saved query, and the result panel's theme harmony (BYT-9496 lock).
import { test, expect, type BrowserContext, type Page } from "@playwright/test";
import { loadTestEnv, type TestEnv } from "../framework/env";
@@ -81,7 +81,7 @@ test.describe("Vertical display preserves the admin-mode dark theme", () => {
// The admin terminal renders an editable CompactSQLEditor at the
// bottom of the query stack. There may be other Monaco instances
- // in the page (the underlying worksheet's editor stays mounted),
+ // in the page (the underlying saved query's editor stays mounted),
// so we anchor by `.last()` to target the prompt.
//
// CompactSQLEditor.tsx:220 wires plain Enter to RunQuery via a
@@ -246,9 +246,9 @@ test.describe("Vertical display preserves the admin-mode dark theme", () => {
});
});
-test.describe("Wrench button is visible for admin users on a connected worksheet", () => {
+test.describe("Wrench button is visible for admin users on a connected saved query", () => {
// AdminModeButton renders only when allowAdmin && tab.mode ===
- // "WORKSHEET" (AdminModeButton.tsx). For the demo admin user with
+ // "SAVED_QUERY" (AdminModeButton.tsx). For the demo admin user with
// a real DB connection, the button must be present and enabled.
test("admin user on a connected DB sees an enabled wrench", async () => {
@@ -267,7 +267,7 @@ test.describe("Wrench is not clickable when no database is connected", () => {
// The user contract: you can't enter admin mode without picking a
// DB first. AdminModeButton.tsx implements this two ways depending
// on context — it returns `null` when there's no current tab, and
- // it renders `disabled` when the tab is in WORKSHEET mode but
+ // it renders `disabled` when the tab is in SAVED_QUERY mode but
// `tabStore.isDisconnected`. Either is a valid "not clickable"
// state; both satisfy the contract.
@@ -291,7 +291,7 @@ test.describe("Wrench is not clickable when no database is connected", () => {
});
test.describe("Clicking the wrench enters the admin terminal", () => {
- // After the click, the editor swaps from WORKSHEET to ADMIN mode.
+ // After the click, the editor swaps from SAVED_QUERY to ADMIN mode.
// TerminalPanel mounts in place of the standard editor — the "SQL>"
// prompt and the "Exit admin mode" toolbar button are the visible
// signals, and the shell mounts with its dark surface (asserted via
@@ -351,10 +351,10 @@ test.describe("Running SELECT 42 in the admin terminal returns a 1-row result",
});
});
-test.describe("Exit admin mode returns to the worksheet view", () => {
+test.describe("Exit admin mode returns to the saved query view", () => {
// The "Exit admin mode" button in the admin toolbar swaps the tab
- // back to WORKSHEET. The dark terminal goes away; the standard
- // worksheet editor (`role="code"` Monaco) is the visible surface
+ // back to SAVED_QUERY. The dark terminal goes away; the standard
+ // saved query editor (`role="code"` Monaco) is the visible surface
// again.
test("clicking Exit admin mode dismounts the terminal", async () => {
@@ -380,7 +380,7 @@ test.describe("Exit admin mode returns to the worksheet view", () => {
// Terminal unmounts: the admin-only "Exit admin mode" button is gone (the
// canonical "admin mode inactive" signal — the dark shell went with it).
await expect(exitBtn).toHaveCount(0);
- // Wrench is back (worksheet mode) and enabled (still connected).
+ // Wrench is back (saved query mode) and enabled (still connected).
await expect(sqlEditor.adminModeButton).toBeVisible({ timeout: 5000 });
await expect(sqlEditor.adminModeButton).toBeEnabled();
});
@@ -388,7 +388,7 @@ test.describe("Exit admin mode returns to the worksheet view", () => {
// Helpers shared by the arrow-key history tests below. Each one drives
// the LAST role="code" Monaco (the editable prompt — older terminal rows
-// are read-only) the same way `setEditorContent` would on a worksheet,
+// are read-only) the same way `setEditorContent` would on a saved query,
// but explicitly targets `.last()`.
async function runInAdminTerminal(statement: string): Promise<void> {
// The admin terminal's editable prompt is the LAST role="code" Monaco
@@ -453,7 +453,7 @@ test.describe("Up/down arrow keys scroll the admin terminal's query history", ()
test.afterEach(async () => {
// Leave admin mode so the next test's beforeAll-shared page returns
- // to a worksheet starting state. (Page is reused across tests in
+ // to a saved query starting state. (Page is reused across tests in
// this file via the file-level `sharedContext` + `page`.)
const exitBtn = page.getByRole("button", {
name: "Exit admin mode",
diff --git a/frontend/tests/e2e/sql-editor/sql-editor-connection.spec.ts b/frontend/tests/e2e/sql-editor/sql-editor-connection.spec.ts
index 8c954fb052..442cfa56ed 100644
--- a/frontend/tests/e2e/sql-editor/sql-editor-connection.spec.ts
+++ b/frontend/tests/e2e/sql-editor/sql-editor-connection.spec.ts
@@ -54,9 +54,9 @@ test.describe("Cold-open lands on the SQL Editor home view", () => {
timeout: 10_000,
});
- // Gutter rail buttons are stable user-facing labels (Worksheet /
+ // Gutter rail buttons are stable user-facing labels (SavedQuery /
// Schema / History gutter tabs).
- await expect(sqlEditor.gutterWorksheetTab).toBeVisible();
+ await expect(sqlEditor.gutterSavedQueryTab).toBeVisible();
await expect(sqlEditor.gutterSchemaTab).toBeVisible();
await expect(sqlEditor.gutterHistoryTab).toBeVisible();
@@ -69,36 +69,36 @@ test.describe("Cold-open lands on the SQL Editor home view", () => {
});
});
-test.describe("Opening a worksheet by UUID restores its title in a tab", () => {
- // C2 — deep-linking into /projects/<p>/sheets/<uuid> must hydrate
- // the worksheet and render its title as the active tab. This is the
+test.describe("Opening a saved query by UUID restores its title in a tab", () => {
+ // C2 — deep-linking into /projects/<p>/savedQueries/<uuid> must hydrate
+ // the saved query and render its title as the active tab. This is the
// shareable-link contract: a URL pasted from chat / the Recent menu
- // must reproducibly land the user on that worksheet.
+ // must reproducibly land the user on that savedQuery.
const SOURCE_TITLE = `e2e-cuj-c2-${Date.now()}`;
const SOURCE_CONTENT = "SELECT 1;";
- let sourceWorksheet = "";
+ let sourceSavedQuery = "";
test.beforeAll(async () => {
- const created = await env.api.createWorksheet(
+ const created = await env.api.createSavedQuery(
env.project,
SOURCE_TITLE,
env.database,
SOURCE_CONTENT,
);
- sourceWorksheet = created.name;
+ sourceSavedQuery = created.name;
});
test.afterAll(async () => {
- if (sourceWorksheet) await env.api.deleteWorksheet(sourceWorksheet);
+ if (sourceSavedQuery) await env.api.deleteSavedQuery(sourceSavedQuery);
});
- test("active tab text matches the worksheet title after deep-link", async () => {
+ test("active tab text matches the saved query title after deep-link", async () => {
test.setTimeout(120_000);
const projectId = env.project.split("/").pop()!;
- const sheetUuid = sourceWorksheet.split("/").pop()!;
+ const sheetUuid = sourceSavedQuery.split("/").pop()!;
await sqlEditor.gotoSheet(projectId, sheetUuid);
await page.waitForTimeout(1500);
@@ -136,7 +136,7 @@ test.describe("Instance-only URL lands without a connected database", () => {
test.describe("Project switcher updates the editor's project context", () => {
// C5 — choosing a different project from the picker must update the
// editor's project context (URL changes to /projects/<newProj>) so
- // the sidebar tree, schema panel, and worksheet list all refresh
+ // the sidebar tree, schema panel, and saved query list all refresh
// against the new project's databases.
//
// The post-demo bootstrap (#20393) only creates one sample project
@@ -144,7 +144,7 @@ test.describe("Project switcher updates the editor's project context", () => {
// project to be a meaningful test. We provision it on-demand here
// (NOT in the global seedTestData) so that adding a second project
// doesn't shift the SQL editor's default landing project for other
- // specs (e.g. sql-editor-worksheet.spec.ts uses gotoHome() and
+ // specs (e.g. sql-editor-saved-query.spec.ts uses gotoHome() and
// assumes `project-sample` is current).
test.beforeAll(async () => {
diff --git a/frontend/tests/e2e/sql-editor/sql-editor-misc.spec.ts b/frontend/tests/e2e/sql-editor/sql-editor-misc.spec.ts
index 81e8c9bfb5..2daef868c1 100644
--- a/frontend/tests/e2e/sql-editor/sql-editor-misc.spec.ts
+++ b/frontend/tests/e2e/sql-editor/sql-editor-misc.spec.ts
@@ -5,7 +5,7 @@
// (SQLEditorRouteShell.tsx:402 reads the param and overrides the
// localStorage-persisted tab).
// - H4 Clicking the gutter tabs switches the visible aside panel
-// (Worksheet ↔ Schema ↔ History).
+// (SavedQuery ↔ Schema ↔ History).
// - H5 The SQL editor's gutter logo opens in a new tab
// (target=_blank + rel=noopener noreferrer) — GutterBar.tsx:49.
// - O1 The QueryContextSettingPopover trigger ("(limit N)") is hidden
@@ -47,7 +47,7 @@ test.afterAll(async () => {
test.describe("Aside panel URL restoration (H3)", () => {
// Locks `?panel=<tab>` deep-link restoration: landing on the SQL editor
// with `?panel=schema` must activate the Schema gutter panel rather than
- // the persisted-default (WORKSHEET) tab. Restoration runs on the
+ // the persisted-default (SAVED_QUERY) tab. Restoration runs on the
// `project-context-ready` event in SQLEditorRouteShell.tsx. Previously
// skipped on a stale "fails under license" note; re-verified passing under
// an enterprise license both in isolation and in the full suite, so it now
@@ -77,11 +77,11 @@ test.describe("Gutter tab switching (H4)", () => {
const projectId = env.project.split("/").pop()!;
await sqlEditor.gotoWithDb(projectId, env.instanceId, env.databaseId);
- // Start by clicking Worksheet — the worksheet tree shows the
- // "Search Sheets" textbox and Mine/Shared/Draft folders.
- await sqlEditor.gutterWorksheetTab.click();
+ // Start by clicking SavedQuery — the saved query tree shows the
+ // "Search saved queries" textbox and Mine/Shared/Draft folders.
+ await sqlEditor.gutterSavedQueryTab.click();
await expect(
- page.getByPlaceholder("Search Sheets").first(),
+ page.getByPlaceholder("Search saved queries").first(),
).toBeVisible({ timeout: 10_000 });
// Switch to Schema — schema rows render.
@@ -91,8 +91,8 @@ test.describe("Gutter tab switching (H4)", () => {
.locator('.bb-schema-tree-row[data-node-meta-type="schema"]')
.first(),
).toBeVisible({ timeout: 10_000 });
- // And the worksheet "Search Sheets" input must NOT be visible.
- await expect(page.getByPlaceholder("Search Sheets")).toHaveCount(0);
+ // And the saved query "Search saved queries" input must NOT be visible.
+ await expect(page.getByPlaceholder("Search saved queries")).toHaveCount(0);
// Switch to History — empty state placeholder OR an existing
// [data-history-row]; both are valid (we run on a fresh server so
@@ -135,7 +135,7 @@ test.describe("QueryContextSettingPopover hidden in admin mode (O1)", () => {
const projectId = env.project.split("/").pop()!;
await sqlEditor.gotoWithDb(projectId, env.instanceId, env.databaseId);
- // In worksheet mode, "(limit N)" appears next to Run.
+ // In saved query mode, "(limit N)" appears next to Run.
await expect(page.getByText(/\(limit\s+\d+\)/i).first()).toBeVisible({
timeout: 10_000,
});
@@ -152,7 +152,7 @@ test.describe("QueryContextSettingPopover hidden in admin mode (O1)", () => {
).toBeVisible({ timeout: 5_000 });
// Exit so any sibling test landing on the same page starts in
- // worksheet mode.
+ // saved query mode.
await page
.getByRole("button", { name: "Exit admin mode", exact: true })
.click();
diff --git a/frontend/tests/e2e/sql-editor/sql-editor-result.spec.ts b/frontend/tests/e2e/sql-editor/sql-editor-result.spec.ts
index fd6857d0a2..ad7ed6323a 100644
--- a/frontend/tests/e2e/sql-editor/sql-editor-result.spec.ts
+++ b/frontend/tests/e2e/sql-editor/sql-editor-result.spec.ts
@@ -29,7 +29,7 @@ test.afterAll(async () => {
});
// Each test re-enters the connected DB URL via gotoWithDb. The SQL
-// editor opens a fresh worksheet tab on that route, isolating each
+// editor opens a fresh saved query tab on that route, isolating each
// test from the previous test's editor content + result state.
// Reusing the same browser context (no new context per test) keeps the
// run fast; the per-test navigation is what gives state isolation.
@@ -431,7 +431,7 @@ test.describe("Detail panel scrolls long content to the last line (BYT-9610)", (
"the bottom lines were off-screen and unreachable",
).toBeInViewport({ timeout: 5000 });
- // Close the sheet so a sibling describe sharing the page starts clean.
+ // Close the tab so a sibling describe sharing the page starts clean.
await page.keyboard.press("Escape");
});
});
diff --git a/frontend/tests/e2e/sql-editor/sql-editor-worksheet.spec.ts b/frontend/tests/e2e/sql-editor/sql-editor-saved-query.spec.ts
similarity index 73%
rename from frontend/tests/e2e/sql-editor/sql-editor-worksheet.spec.ts
rename to frontend/tests/e2e/sql-editor/sql-editor-saved-query.spec.ts
index 3d06cfbf40..b666825c30 100644
--- a/frontend/tests/e2e/sql-editor/sql-editor-worksheet.spec.ts
+++ b/frontend/tests/e2e/sql-editor/sql-editor-saved-query.spec.ts
@@ -1,8 +1,8 @@
-// SQL Editor — worksheet operations.
+// SQL Editor — saved query operations.
//
-// Covers worksheet-level actions taken from the sidebar tree:
+// Covers saved query-level actions taken from the sidebar tree:
// create, duplicate, delete, save, search. Tests in this file each
-// set up their own worksheet via the API and drop it in afterAll,
+// set up their own saved query via the API and drop it in afterAll,
// never reusing demo data.
import { test, expect, type BrowserContext, type Page } from "@playwright/test";
@@ -28,10 +28,10 @@ test.afterAll(async () => {
});
test.describe("Share popover copy-link button (BYT-9667)", () => {
- // BYT-9667 (FIXED, #20541): the worksheet Share popover's URL copy icon looked
+ // BYT-9667 (FIXED, #20541): the saved query Share popover's URL copy icon looked
// inert — same flat grey background as the addon segments, no hover/click
// feedback (only a bottom toast). The comment thread added two contracts:
- // (a) the copy button must stay CLICKABLE for PRIVATE worksheets (an interim
+ // (a) the copy button must stay CLICKABLE for PRIVATE saved queries (an interim
// change disabled it for private — Peter rejected that), and
// (b) it should be disabled ONLY while the tab has unsaved changes.
// The fix converts it to the shared ghost Button (white bg, grey on hover via
@@ -48,12 +48,12 @@ test.describe("Share popover copy-link button (BYT-9667)", () => {
let page9667: Page;
let editor9667: SqlEditorPage;
const TITLE = `e2e-byt9667-${Date.now()}`;
- let worksheet = "";
+ let savedQuery = "";
test.beforeAll(async ({ browser }) => {
// Created PRIVATE by default — exactly the regression cell.
- worksheet = (
- await env.api.createWorksheet(env.project, TITLE, env.database, "SELECT 1;")
+ savedQuery = (
+ await env.api.createSavedQuery(env.project, TITLE, env.database, "SELECT 1;")
).name;
ctx9667 = await browser.newContext({
storageState: ".auth/state.json",
@@ -64,15 +64,15 @@ test.describe("Share popover copy-link button (BYT-9667)", () => {
});
test.afterAll(async () => {
- if (worksheet) await env.api.deleteWorksheet(worksheet);
+ if (savedQuery) await env.api.deleteSavedQuery(savedQuery);
await ctx9667?.close();
});
- test("copy button is enabled for a private worksheet, responds to hover, and copies the deep link", async () => {
+ test("copy button is enabled for a private saved query, responds to hover, and copies the deep link", async () => {
test.setTimeout(120_000);
const projectId = env.project.split("/").pop()!;
- const sheetUuid = worksheet.split("/").pop()!;
+ const sheetUuid = savedQuery.split("/").pop()!;
await editor9667.gotoSheet(projectId, sheetUuid);
await page9667.waitForTimeout(1500);
@@ -91,10 +91,10 @@ test.describe("Share popover copy-link button (BYT-9667)", () => {
const copyBtn = page9667.locator("[data-copy-btn]");
await expect(copyBtn).toBeVisible({ timeout: 5000 });
- // (a) Regression: the copy button stays clickable for a PRIVATE worksheet.
+ // (a) Regression: the copy button stays clickable for a PRIVATE savedQuery.
await expect(
copyBtn,
- "the copy button must remain enabled for a private worksheet",
+ "the copy button must remain enabled for a private saved query",
).toBeEnabled();
// (b) Visual response: hovering changes the background (white → hover grey).
@@ -113,16 +113,16 @@ test.describe("Share popover copy-link button (BYT-9667)", () => {
`bug: static grey, no hover feedback). before=${bgBefore} hover=${bgHover}`,
).not.toBe(bgBefore);
- // (c) Clicking copies the worksheet deep link + raises the success toast.
+ // (c) Clicking copies the saved query deep link + raises the success toast.
await copyBtn.click();
await expect(
- page9667.getByText("The URL is copied to your clipboard").first(),
+ page9667.getByText("Link copied to clipboard").first(),
).toBeVisible({ timeout: 5000 });
const clipboard = await page9667.evaluate(() =>
navigator.clipboard.readText(),
);
expect(clipboard).toMatch(
- new RegExp(`/sql-editor/projects/[^/]+/sheets/${sheetUuid}`),
+ new RegExp(`/sql-editor/projects/[^/]+/savedQueries/${sheetUuid}`),
);
});
@@ -130,7 +130,7 @@ test.describe("Share popover copy-link button (BYT-9667)", () => {
test.setTimeout(120_000);
const projectId = env.project.split("/").pop()!;
- const sheetUuid = worksheet.split("/").pop()!;
+ const sheetUuid = savedQuery.split("/").pop()!;
await editor9667.gotoSheet(projectId, sheetUuid);
await page9667.waitForTimeout(1500);
await expect(editor9667.activeTab()).toContainText(TITLE, {
@@ -161,13 +161,13 @@ test.describe("Share popover copy-link button (BYT-9667)", () => {
});
test.describe("Multi-select delete shows the dedicated confirm dialog (BYT-9631)", () => {
- // BYT-9631 (FIXED, #20541): selecting multiple worksheets via Multi-select and
+ // BYT-9631 (FIXED, #20541): selecting multiple saved queries via Multi-select and
// clicking Delete showed the WRONG dialog — the single-folder "Non-empty
- // folder" prompt ("Do you want to move all worksheets into the root folder or
- // just delete them?") with a "Delete all files" / "Move to root folder"
+ // folder" prompt ("Do you want to move all saved queries into the root folder or
+ // just delete them?") with a "Delete all" / "Move to root folder"
// choice. For an explicit multi-selection that was confusing and offered a
// nonsensical "move to root folder" option. The fix routes multi-delete to a
- // dedicated AlertDialog: "Delete selected items?" / "The selected worksheets
+ // dedicated AlertDialog: "Delete selected items?" / "The selected saved queries
// and folders will be permanently deleted."
const STAMP = Date.now();
@@ -179,30 +179,30 @@ test.describe("Multi-select delete shows the dedicated confirm dialog (BYT-9631)
let wsC = "";
test.beforeAll(async () => {
- wsA = (await env.api.createWorksheet(env.project, TITLE_A, env.database, "SELECT 1;")).name;
- wsB = (await env.api.createWorksheet(env.project, TITLE_B, env.database, "SELECT 2;")).name;
- wsC = (await env.api.createWorksheet(env.project, TITLE_C, env.database, "SELECT 3;")).name;
+ wsA = (await env.api.createSavedQuery(env.project, TITLE_A, env.database, "SELECT 1;")).name;
+ wsB = (await env.api.createSavedQuery(env.project, TITLE_B, env.database, "SELECT 2;")).name;
+ wsC = (await env.api.createSavedQuery(env.project, TITLE_C, env.database, "SELECT 3;")).name;
});
test.afterAll(async () => {
- // A and B may already be deleted by the test; deleteWorksheet swallows 404.
+ // A and B may already be deleted by the test; deleteSavedQuery swallows 404.
for (const ws of [wsA, wsB, wsC]) {
- if (ws) await env.api.deleteWorksheet(ws);
+ if (ws) await env.api.deleteSavedQuery(ws);
}
});
- test("deleting two checked worksheets uses the multi-select dialog, not the non-empty-folder prompt", async () => {
+ test("deleting two checked saved queries uses the multi-select dialog, not the non-empty-folder prompt", async () => {
test.setTimeout(120_000);
await sqlEditor.gotoHome();
await page.waitForTimeout(1000);
- const tree = page.locator(".worksheet-tree");
+ const tree = page.getByTestId("saved-query-tree");
await expect(tree.getByText(TITLE_A).first()).toBeVisible({
timeout: 10_000,
});
- // Enter multi-select via the worksheet row's context menu.
+ // Enter multi-select via the saved query row's context menu.
await tree.getByText(TITLE_A).first().click({ button: "right" });
const multiSelectItem = page.getByRole("menuitem", {
name: "Multi-select",
@@ -239,13 +239,13 @@ test.describe("Multi-select delete shows the dedicated confirm dialog (BYT-9631)
await expect(dialog.getByText("Delete selected items?")).toBeVisible();
await expect(
dialog.getByText(
- "The selected worksheets and folders will be permanently deleted.",
+ "The selected saved queries and folders will be permanently deleted.",
),
).toBeVisible();
// The wrong (pre-fix) dialog must be absent.
await expect(page.getByText("Non-empty folder")).toHaveCount(0);
await expect(
- page.getByRole("button", { name: "Delete all files" }),
+ page.getByRole("button", { name: "Delete all" }),
).toHaveCount(0);
await expect(
page.getByRole("button", { name: "Move to root folder" }),
@@ -262,9 +262,9 @@ test.describe("Multi-select delete shows the dedicated confirm dialog (BYT-9631)
test.describe("Duplicate", () => {
// The duplicate handler in SheetTree.tsx (around line 1152) calls
- // editorWorksheetStore.createWorksheet({ title, folders, database })
+ // editorSavedQueryStore.createSavedQuery({ title, folders, database })
// and is missing the `content` (or `statement`) field. As a result the
- // duplicated worksheet inherits the title and connection but its body
+ // duplicated saved query inherits the title and connection but its body
// is empty — a silent data-loss bug visible only after clicking into
// the new tab.
//
@@ -275,32 +275,32 @@ test.describe("Duplicate", () => {
const SOURCE_CONTENT = "SELECT 42;";
const SOURCE_TITLE = `e2e-duplicate-${Date.now()}`;
- let sourceWorksheet = "";
- let duplicateWorksheet = "";
+ let sourceSavedQuery = "";
+ let duplicateSavedQuery = "";
test.beforeAll(async () => {
- const created = await env.api.createWorksheet(
+ const created = await env.api.createSavedQuery(
env.project,
SOURCE_TITLE,
env.database,
SOURCE_CONTENT,
);
- sourceWorksheet = created.name;
+ sourceSavedQuery = created.name;
});
test.afterAll(async () => {
- if (sourceWorksheet) await env.api.deleteWorksheet(sourceWorksheet);
- if (duplicateWorksheet) await env.api.deleteWorksheet(duplicateWorksheet);
+ if (sourceSavedQuery) await env.api.deleteSavedQuery(sourceSavedQuery);
+ if (duplicateSavedQuery) await env.api.deleteSavedQuery(duplicateSavedQuery);
});
- test("duplicating a worksheet preserves the SQL body", async () => {
+ test("duplicating a saved query preserves the SQL body", async () => {
// R26 — Duplicate drops the SQL body. Queued as not-high-priority;
// mark expected-fail until the SheetTree.tsx duplicate handler is
// patched to pass `content` through. Passing here will re-flag it
// for marker removal.
test.fail();
test.setTimeout(120_000);
- const sourceUuid = sourceWorksheet.split("/").pop()!;
+ const sourceUuid = sourceSavedQuery.split("/").pop()!;
const projectId = env.project.split("/").pop()!;
await sqlEditor.gotoSheet(projectId, sourceUuid);
await page.waitForTimeout(1500);
@@ -312,9 +312,9 @@ test.describe("Duplicate", () => {
});
// Right-click the source row in the sidebar tree to open the
- // worksheet context menu. Anchor by the unique title text.
+ // saved query context menu. Anchor by the unique title text.
const sourceRow = page
- .locator(".worksheet-tree")
+ .getByTestId("saved-query-tree")
.getByText(SOURCE_TITLE)
.first();
await expect(sourceRow).toBeVisible({ timeout: 10_000 });
@@ -327,7 +327,7 @@ test.describe("Duplicate", () => {
await expect(duplicateItem).toBeVisible({ timeout: 5000 });
await duplicateItem.click();
- // The AlertDialog ("Confirm to duplicate this worksheet?") opens.
+ // The AlertDialog ("Duplicate this saved query?") opens.
const dialog = page.getByRole("alertdialog");
await expect(dialog).toBeVisible({ timeout: 5000 });
@@ -347,7 +347,7 @@ test.describe("Duplicate", () => {
const newUuid = page.url().match(/\/sheets\/([0-9a-f-]+)/i)?.[1];
if (newUuid) {
- duplicateWorksheet = `${projectPrefix}/worksheets/${newUuid}`;
+ duplicateSavedQuery = `${projectPrefix}/savedQueries/${newUuid}`;
}
// Wait for Monaco on the new tab to settle before reading its value.
@@ -366,44 +366,44 @@ test.describe("Duplicate", () => {
});
});
-test.describe("Right-click → Delete prompts for confirmation and removes the worksheet", () => {
- // Deleting a worksheet from the sidebar must surface a confirm
+test.describe("Right-click → Delete prompts for confirmation and removes the saved query", () => {
+ // Deleting a saved query from the sidebar must surface a confirm
// dialog before the destructive action. After confirmation, the
- // worksheet vanishes from the sidebar tree.
+ // saved query vanishes from the sidebar tree.
const TARGET_TITLE = `e2e-delete-${Date.now()}`;
- let createdWorksheet = "";
+ let createdSavedQuery = "";
test.beforeAll(async () => {
- const created = await env.api.createWorksheet(
+ const created = await env.api.createSavedQuery(
env.project,
TARGET_TITLE,
env.database,
"SELECT 'to-delete';",
);
- createdWorksheet = created.name;
+ createdSavedQuery = created.name;
});
test.afterAll(async () => {
- // If the test deleted the worksheet, the API delete here is a
+ // If the test deleted the saved query, the API delete here is a
// no-op. If the test failed before deletion, this cleans up.
- if (createdWorksheet) {
- await env.api.deleteWorksheet(createdWorksheet);
+ if (createdSavedQuery) {
+ await env.api.deleteSavedQuery(createdSavedQuery);
}
});
- test("confirming the alert removes the worksheet from the sidebar", async () => {
+ test("confirming the alert removes the saved query from the sidebar", async () => {
test.setTimeout(120_000);
const projectId = env.project.split("/").pop()!;
await sqlEditor.gotoHome();
await page.waitForTimeout(800);
- // The worksheet appears in the sidebar tree under "Mine" — find
+ // The saved query appears in the sidebar tree under "Mine" — find
// by its unique title.
const row = page
- .locator(".worksheet-tree")
+ .getByTestId("saved-query-tree")
.getByText(TARGET_TITLE)
.first();
await expect(row).toBeVisible({ timeout: 10_000 });
@@ -419,47 +419,47 @@ test.describe("Right-click → Delete prompts for confirmation and removes the w
const dialog = page.getByRole("alertdialog");
await expect(dialog).toBeVisible({ timeout: 5000 });
// The destructive confirm reads "Delete" (matches the action) —
- // not "Confirm" like the duplicate-worksheet dialog uses.
+ // not "Confirm" like the duplicate-saved-query dialog uses.
await dialog.getByRole("button", { name: "Delete", exact: true }).click();
await expect(dialog).not.toBeVisible({ timeout: 5000 });
// The row must disappear from the sidebar tree.
await expect(
- page.locator(".worksheet-tree").getByText(TARGET_TITLE),
+ page.getByTestId("saved-query-tree").getByText(TARGET_TITLE),
).toHaveCount(0, { timeout: 10_000 });
- // Mark the worksheet as already deleted so afterAll doesn't
- // double-delete (deleteWorksheet swallows errors but log noise
+ // Mark the saved query as already deleted so afterAll doesn't
+ // double-delete (deleteSavedQuery swallows errors but log noise
// would suggest a real problem).
void projectId;
- createdWorksheet = "";
+ createdSavedQuery = "";
});
});
-test.describe("Sidebar search filters the worksheet list", () => {
- // Typing into the "Search Sheets" input filters the visible
- // worksheet rows to those whose title matches the keyword.
+test.describe("Sidebar search filters the saved query list", () => {
+ // Typing into the "Search saved queries" input filters the visible
+ // saved query rows to those whose title matches the keyword.
// Non-matching rows must disappear; matching rows must stay.
- // Two worksheets with distinct unique tokens — the search keyword
+ // Two saved queries with distinct unique tokens — the search keyword
// matches one and excludes the other.
const STAMP = Date.now();
const NEEDLE_TITLE = `e2e-search-needle-${STAMP}`;
const HAYSTACK_TITLE = `e2e-search-other-${STAMP}`;
- let needleWorksheet = "";
- let haystackWorksheet = "";
+ let needleSavedQuery = "";
+ let haystackSavedQuery = "";
test.beforeAll(async () => {
- needleWorksheet = (
- await env.api.createWorksheet(
+ needleSavedQuery = (
+ await env.api.createSavedQuery(
env.project,
NEEDLE_TITLE,
env.database,
"SELECT 1;",
)
).name;
- haystackWorksheet = (
- await env.api.createWorksheet(
+ haystackSavedQuery = (
+ await env.api.createSavedQuery(
env.project,
HAYSTACK_TITLE,
env.database,
@@ -469,38 +469,38 @@ test.describe("Sidebar search filters the worksheet list", () => {
});
test.afterAll(async () => {
- if (needleWorksheet) await env.api.deleteWorksheet(needleWorksheet);
- if (haystackWorksheet) await env.api.deleteWorksheet(haystackWorksheet);
+ if (needleSavedQuery) await env.api.deleteSavedQuery(needleSavedQuery);
+ if (haystackSavedQuery) await env.api.deleteSavedQuery(haystackSavedQuery);
});
- test('typing "needle" hides the non-matching worksheet', async () => {
+ test('typing "needle" hides the non-matching saved query', async () => {
test.setTimeout(120_000);
await sqlEditor.gotoHome();
await page.waitForTimeout(800);
- // Both worksheets visible at baseline.
+ // Both saved queries visible at baseline.
await expect(
- page.locator(".worksheet-tree").getByText(NEEDLE_TITLE),
+ page.getByTestId("saved-query-tree").getByText(NEEDLE_TITLE),
).toBeVisible({ timeout: 10_000 });
await expect(
- page.locator(".worksheet-tree").getByText(HAYSTACK_TITLE),
+ page.getByTestId("saved-query-tree").getByText(HAYSTACK_TITLE),
).toBeVisible();
- // The Search Sheets input is a textbox in the worksheet pane.
- const search = page.getByPlaceholder("Search Sheets").first();
+ // The search input is a textbox in the saved query pane.
+ const search = page.getByPlaceholder("Search saved queries").first();
await expect(search).toBeVisible({ timeout: 5000 });
await search.fill("needle");
// Search is debounced (DEBOUNCE_SEARCH_DELAY constant in the
- // worksheet store). Wait for the filter to settle.
+ // saved query store). Wait for the filter to settle.
await page.waitForTimeout(800);
// Needle stays, haystack disappears.
await expect(
- page.locator(".worksheet-tree").getByText(NEEDLE_TITLE),
+ page.getByTestId("saved-query-tree").getByText(NEEDLE_TITLE),
).toBeVisible();
await expect(
- page.locator(".worksheet-tree").getByText(HAYSTACK_TITLE),
+ page.getByTestId("saved-query-tree").getByText(HAYSTACK_TITLE),
).toHaveCount(0);
// Reset for any sibling describe sharing the page.
@@ -510,20 +510,20 @@ test.describe("Sidebar search filters the worksheet list", () => {
});
test.describe("Mine / Shared / Draft folders collapse and re-expand", () => {
- // Each top-level folder in the worksheet tree (Mine, Shared, Draft)
+ // Each top-level folder in the saved query tree (Mine, Shared, Draft)
// is independently collapsible. Clicking a folder header toggles
// its expanded state — its children disappear, and clicking again
// brings them back.
const STAMP = Date.now();
const TITLE = `e2e-collapse-${STAMP}`;
- let createdWorksheet = "";
+ let createdSavedQuery = "";
test.beforeAll(async () => {
- // Create one worksheet under Mine so we have a child whose
+ // Create one saved query under Mine so we have a child whose
// visibility we can probe.
- createdWorksheet = (
- await env.api.createWorksheet(
+ createdSavedQuery = (
+ await env.api.createSavedQuery(
env.project,
TITLE,
env.database,
@@ -533,7 +533,7 @@ test.describe("Mine / Shared / Draft folders collapse and re-expand", () => {
});
test.afterAll(async () => {
- if (createdWorksheet) await env.api.deleteWorksheet(createdWorksheet);
+ if (createdSavedQuery) await env.api.deleteSavedQuery(createdSavedQuery);
});
test("clicking Mine hides its children, clicking again restores them", async () => {
@@ -542,11 +542,11 @@ test.describe("Mine / Shared / Draft folders collapse and re-expand", () => {
await sqlEditor.gotoHome();
await page.waitForTimeout(800);
- const child = page.locator(".worksheet-tree").getByText(TITLE).first();
+ const child = page.getByTestId("saved-query-tree").getByText(TITLE).first();
await expect(child).toBeVisible({ timeout: 10_000 });
const mineFolder = page
- .locator(".worksheet-tree")
+ .getByTestId("saved-query-tree")
.getByRole("treeitem")
.filter({ hasText: /^Mine$/ })
.first();
diff --git a/frontend/tests/e2e/sql-editor/sql-editor-schema.spec.ts b/frontend/tests/e2e/sql-editor/sql-editor-schema.spec.ts
index ad19194248..1641ead43e 100644
--- a/frontend/tests/e2e/sql-editor/sql-editor-schema.spec.ts
+++ b/frontend/tests/e2e/sql-editor/sql-editor-schema.spec.ts
@@ -193,7 +193,7 @@ test.describe("Schema search filters the schema tree", () => {
// The schema tree input has placeholder t("common.search") = "Search".
// It's the only Search-placeholder textbox visible inside the
- // schema gutter pane (the worksheet pane uses "Search Sheets").
+ // schema gutter pane (the saved query pane uses "Search saved queries").
const searchBox = page.getByPlaceholder("Search").first();
await expect(searchBox).toBeVisible({ timeout: 10_000 });
await searchBox.fill("employee");
diff --git a/frontend/tests/e2e/sql-editor/sql-editor-tabs.spec.ts b/frontend/tests/e2e/sql-editor/sql-editor-tabs.spec.ts
index 79bc320ff3..b5759f1927 100644
--- a/frontend/tests/e2e/sql-editor/sql-editor-tabs.spec.ts
+++ b/frontend/tests/e2e/sql-editor/sql-editor-tabs.spec.ts
@@ -1,7 +1,7 @@
// SQL Editor — tab strip behavior.
//
// Covers the top tab strip's contract:
-// - Active tab text reflects the live worksheet state (title + connection)
+// - Active tab text reflects the live saved query state (title + connection)
// - Tab strip remains scrollable when more tabs open than fit the viewport
// - Right-click on a tab opens the close-actions context menu
// - Closing a tab with unsaved changes prompts for confirmation
@@ -31,7 +31,7 @@ test.afterAll(async () => {
test.describe("Active tab text tracks the live connection", () => {
// BYT-9392 (originally surfaced as SUP-197): when the user switches
- // the database connection on a worksheet via the breadcrumb picker,
+ // the database connection on a saved query via the breadcrumb picker,
// the breadcrumb, schema tree, and schema dropdown all update to the
// new database — but the TAB TITLE keeps showing the old DB name.
//
@@ -56,9 +56,9 @@ test.describe("Active tab text tracks the live connection", () => {
// Title intentionally embeds the source DB name verbatim — that is
// the entire premise of the bug (the title is set once at create
// time and never re-derived when the connection changes).
- const WORKSHEET_TITLE = `${SOURCE_DB_SHORT} e2e-tab-title-${Date.now()}`;
+ const SAVED_QUERY_TITLE = `${SOURCE_DB_SHORT} e2e-tab-title-${Date.now()}`;
- let sourceWorksheet = "";
+ let sourceSavedQuery = "";
test.beforeAll(async () => {
const source = await env.api.findDatabaseByShortName(SOURCE_DB_SHORT);
@@ -81,32 +81,32 @@ test.describe("Active tab text tracks the live connection", () => {
const project =
(dbRecord as { project?: string } | undefined)?.project ?? env.project;
- const created = await env.api.createWorksheet(
+ const created = await env.api.createSavedQuery(
project,
- WORKSHEET_TITLE,
+ SAVED_QUERY_TITLE,
source.database,
"SELECT 1;",
);
- sourceWorksheet = created.name;
+ sourceSavedQuery = created.name;
});
test.afterAll(async () => {
- if (sourceWorksheet) {
- await env.api.deleteWorksheet(sourceWorksheet);
+ if (sourceSavedQuery) {
+ await env.api.deleteSavedQuery(sourceSavedQuery);
}
});
- test("tab title is the worksheet name and does NOT pick up the new DB name after a connection switch", async () => {
+ test("tab title is the saved query name and does NOT pick up the new DB name after a connection switch", async () => {
test.setTimeout(120_000);
- const sourceUuid = sourceWorksheet.split("/").pop()!;
- const projectId = sourceWorksheet.split("/")[1];
+ const sourceUuid = sourceSavedQuery.split("/").pop()!;
+ const projectId = sourceSavedQuery.split("/")[1];
await sqlEditor.gotoSheet(projectId, sourceUuid);
await page.waitForTimeout(2000);
- // Sanity: tab title reflects the worksheet's name on first open.
+ // Sanity: tab title reflects the saved query's name on first open.
// (The name happens to contain SOURCE_DB_SHORT because we composed
// it that way at create time — that's purely incidental.)
- await expect(sqlEditor.activeTab()).toContainText(WORKSHEET_TITLE, {
+ await expect(sqlEditor.activeTab()).toContainText(SAVED_QUERY_TITLE, {
timeout: 10_000,
});
@@ -134,11 +134,11 @@ test.describe("Active tab text tracks the live connection", () => {
await page.waitForTimeout(500);
// Current product behavior (R7 fix): the tab title is the
- // worksheet name and is NOT augmented with the live DB. So after
+ // saved query name and is NOT augmented with the live DB. So after
// switching to TARGET_DB_SHORT (hr_test), the tab still shows the
- // original worksheet title and does NOT contain TARGET_DB_SHORT —
+ // original saved query title and does NOT contain TARGET_DB_SHORT —
// the DB info lives in the breadcrumb only.
- await expect(sqlEditor.activeTab()).toContainText(WORKSHEET_TITLE, {
+ await expect(sqlEditor.activeTab()).toContainText(SAVED_QUERY_TITLE, {
timeout: 5000,
});
await expect(sqlEditor.activeTab()).not.toContainText(TARGET_DB_SHORT);
@@ -164,7 +164,7 @@ test.describe("Tab strip scrolls when tabs overflow the viewport", () => {
//
// Why this matters: the work in clipped tabs is effectively orphaned —
// the user can't switch to those tabs without closing the visible ones
- // first. Combined with worksheet-level data-loss bugs (e.g. duplicate
+ // first. Combined with saved query-level data-loss bugs (e.g. duplicate
// dropping content), unsaved work in inaccessible tabs disappears.
// Reset viewport in afterAll — sibling describes share the page
@@ -172,25 +172,25 @@ test.describe("Tab strip scrolls when tabs overflow the viewport", () => {
const DEFAULT_VIEWPORT = { width: 1280, height: 720 };
const NARROW_VIEWPORT = { width: 900, height: 700 };
const TARGET_TAB_COUNT = 8;
- const WORKSHEET_TITLE_PREFIX = `e2e-tabs-${Date.now()}-`;
+ const SAVED_QUERY_TITLE_PREFIX = `e2e-tabs-${Date.now()}-`;
- let createdWorksheets: string[] = [];
+ let createdSavedQueries: string[] = [];
test.beforeAll(async () => {
- // Pre-create the worksheets via API with a real DB connection.
- // Clicking the in-page "+" Add button creates worksheets WITHOUT a
- // database (worksheetStore.createWorksheet({}) — TabList.tsx:163),
+ // Pre-create the saved queries via API with a real DB connection.
+ // Clicking the in-page "+" Add button creates saved queries WITHOUT a
+ // database (savedQueryStore.createSavedQuery({}) — TabList.tsx:163),
// which makes the editor pop the connection panel after each click
- // and starves the loop. Pre-created worksheets bypass that path
+ // and starves the loop. Pre-created saved queries bypass that path
// entirely and become tabs the moment we navigate to them.
for (let i = 0; i < TARGET_TAB_COUNT; i++) {
- const created = await env.api.createWorksheet(
+ const created = await env.api.createSavedQuery(
env.project,
- `${WORKSHEET_TITLE_PREFIX}${i}`,
+ `${SAVED_QUERY_TITLE_PREFIX}${i}`,
env.database,
`SELECT ${i};`,
);
- createdWorksheets.push(created.name);
+ createdSavedQueries.push(created.name);
}
});
@@ -198,10 +198,10 @@ test.describe("Tab strip scrolls when tabs overflow the viewport", () => {
if (page) {
await page.setViewportSize(DEFAULT_VIEWPORT).catch(() => {});
}
- for (const name of createdWorksheets) {
- await env.api.deleteWorksheet(name);
+ for (const name of createdSavedQueries) {
+ await env.api.deleteSavedQuery(name);
}
- createdWorksheets = [];
+ createdSavedQueries = [];
});
test("horizontal scrollbar is reachable with enough tabs to overflow", async () => {
@@ -209,22 +209,22 @@ test.describe("Tab strip scrolls when tabs overflow the viewport", () => {
await page.setViewportSize(NARROW_VIEWPORT);
- // Open all the pre-created worksheets as tabs by navigating to each
+ // Open all the pre-created saved queries as tabs by navigating to each
// sheet URL in turn. The SQL editor remembers open tabs per project
// (tabStore.openTabList), so subsequent navigations append to the
// strip rather than replacing the active tab.
const projectId = env.project.split("/").pop()!;
- for (const name of createdWorksheets) {
+ for (const name of createdSavedQueries) {
const uuid = name.split("/").pop()!;
await sqlEditor.gotoSheet(projectId, uuid);
}
await page.waitForTimeout(500);
- // Sanity: every worksheet became a tab.
+ // Sanity: every saved query became a tab.
const tabCount = await sqlEditor.tabCount();
expect(
tabCount,
- `every pre-created worksheet should appear as a tab (got ${tabCount})`,
+ `every pre-created saved query should appear as a tab (got ${tabCount})`,
).toBeGreaterThanOrEqual(TARGET_TAB_COUNT);
// The outer scrollable container is the only direct child of
@@ -285,7 +285,7 @@ test.describe("Tab strip scrolls when tabs overflow the viewport", () => {
test.describe("Right-click on a tab opens the close-actions menu", () => {
// Right-click on a tab in the strip opens a Base UI dropdown menu
- // with the standard set of close actions and (for worksheet tabs)
+ // with the standard set of close actions and (for saved query tabs)
// a Rename item. Six items total when Rename is shown.
test("the menu lists Close / Close others / Close to the right / Close saved / Close all / Rename", async () => {
diff --git a/frontend/tests/e2e/sql-editor/sql-editor.page.ts b/frontend/tests/e2e/sql-editor/sql-editor.page.ts
index f8f9023db8..caa693966e 100644
--- a/frontend/tests/e2e/sql-editor/sql-editor.page.ts
+++ b/frontend/tests/e2e/sql-editor/sql-editor.page.ts
@@ -10,7 +10,7 @@ export class SqlEditorPage {
readonly runButton: Locator;
readonly saveButton: Locator;
readonly adminModeButton: Locator;
- readonly gutterWorksheetTab: Locator;
+ readonly gutterSavedQueryTab: Locator;
readonly gutterSchemaTab: Locator;
readonly gutterHistoryTab: Locator;
readonly gutterAccessTab: Locator;
@@ -33,7 +33,7 @@ export class SqlEditorPage {
this.runButton = page.locator("button").filter({ has: page.locator("svg.lucide-play") }).first();
this.saveButton = page.getByRole("button", { name: "Save", exact: true });
// AdminModeButton has a lucide-wrench icon and renders only when
- // editorStore.allowAdmin && currentTab.mode === "WORKSHEET".
+ // editorStore.allowAdmin && currentTab.mode === "SAVED_QUERY".
//
// Scoping note: the workspace-level "Bytebase has not configured
// --external-url" banner (frontend/src/components/BannersWrapper.tsx)
@@ -48,7 +48,10 @@ export class SqlEditorPage {
.locator("button.border-warning")
.filter({ has: page.locator("svg.lucide-wrench") })
.first();
- this.gutterWorksheetTab = page.getByRole("button", { name: "Worksheet", exact: true });
+ this.gutterSavedQueryTab = page.getByRole("button", {
+ name: "Saved queries",
+ exact: true,
+ });
this.gutterSchemaTab = page.getByRole("button", { name: "Schema", exact: true });
this.gutterHistoryTab = page.getByRole("button", { name: "History", exact: true });
// ACCESS gutter tab only renders when project.allowJustInTimeAccess=true.
@@ -104,7 +107,7 @@ export class SqlEditorPage {
async gotoSheet(projectId: string, sheetUuid: string) {
await this.page.goto(
- `${this.baseURL}/sql-editor/projects/${projectId}/sheets/${sheetUuid}`
+ `${this.baseURL}/sql-editor/projects/${projectId}/savedQueries/${sheetUuid}`
);
await this.page.keyboard.press("Escape").catch(() => {});
await this.page.waitForTimeout(1000);
@@ -164,7 +167,7 @@ export class SqlEditorPage {
// NOT exposed on the production React bundle, so any read MUST go through
// the rendered `.view-lines` (a `monaco.editor.getEditors()` read returns
// undefined and silently yields ""). `which`:
- // - "first" the first role="code" surface (the worksheet editor)
+ // - "first" the first role="code" surface (the saved query editor)
// - "last" the last surface (the admin terminal's editable prompt)
// - "longest" the surface with the most content (ignores empty panes)
async readEditorContent(
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index 0f0fdf383e..68ee44a128 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -13684,16 +13684,16 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/bytebase.v1.ListRolloutsResponse'
- /v1/projects/{project}/serviceAccounts:
+ /v1/projects/{project}/savedQueries:
get:
tags:
- - ServiceAccountService
- summary: ListServiceAccounts
+ - SavedQueryService
+ summary: ListSavedQueries
description: |-
- Lists service accounts.
- For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.list on workspace.
- For project-level: parent is projects/{project}, permission bb.serviceAccounts.list on project.
- operationId: ServiceAccountService_ListServiceAccounts
+ List saved queries.
+ This is used for listing saved queries in a project, or across all projects by using `projects/-`.
+ Permissions required: bb.worksheets.list
+ operationId: SavedQueryService_ListSavedQueries
parameters:
- name: project
in: path
@@ -13701,12 +13701,27 @@ paths:
required: true
schema:
type: string
+ - name: filter
+ in: query
+ description: |-
+ To filter the list result.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+ Supported filter:
+ - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+
+ For example:
+ creator == "users/{email}"
+ creator != "users/{email}"
+ schema:
+ type: string
+ title: filter
- name: pageSize
in: query
description: |-
- The maximum number of service accounts to return. The service may return fewer than
+ The maximum number of saved queries to return. The service may return fewer than
this value.
- If unspecified, at most 10 service accounts will be returned.
+ If unspecified, at most 10 saved queries will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
schema:
type: integer
@@ -13715,56 +13730,29 @@ paths:
- name: pageToken
in: query
description: |-
- A page token, received from a previous `ListServiceAccounts` call.
+ A page token, received from a previous `ListSavedQueries` call.
Provide this to retrieve the subsequent page.
- When paginating, all other parameters provided to `ListServiceAccounts` must match
+ When paginating, all other parameters provided to `ListSavedQueries` must match
the call that provided the page token.
schema:
type: string
title: page_token
- - name: showDeleted
- in: query
- description: Show deleted service accounts if specified.
- schema:
- type: boolean
- title: show_deleted
- - name: filter
- in: query
- description: |-
- Filter is used to filter service accounts returned in the list.
- The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
- Supported filter:
- - name: the service account name, support "==" and ".contains()" operator.
- - email: the service account email, support "==" and ".contains()" operator.
- - state: check State enum for values, support "==" operator.
-
- For example:
- name == "ed"
- name.contains("ed")
- state == "DELETED"
- email == "[email protected]"
- email.contains("ed")
- schema:
- type: string
- title: filter
responses:
"200":
description: Success
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ListServiceAccountsResponse'
+ $ref: '#/components/schemas/bytebase.v1.ListSavedQueriesResponse'
post:
tags:
- - ServiceAccountService
- summary: CreateServiceAccount
+ - SavedQueryService
+ summary: CreateSavedQuery
description: |-
- Creates a new service account.
- For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.create on workspace.
- For project-level: parent is projects/{project}, permission bb.serviceAccounts.create on project.
- operationId: ServiceAccountService_CreateServiceAccount
+ Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries.
+ Permissions required: None (authenticated users only)
+ operationId: SavedQueryService_CreateSavedQuery
parameters:
- name: project
in: path
@@ -13772,40 +13760,31 @@ paths:
required: true
schema:
type: string
- - name: serviceAccountId
- in: query
- description: |-
- The ID to use for the service account, which will become the final component
- of the service account's email in the format: {service_account_id}@service.bytebase.com
- or {service_account_id}@{project-id}.service.bytebase.com
- required: true
- schema:
- type: string
- title: service_account_id
requestBody:
- description: The service account to create.
+ description: The saved query to create.
content:
application/json:
schema:
- title: service_account
- description: The service account to create.
- $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
+ title: saved_query
+ description: The saved query to create.
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
responses:
"200":
description: Success
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
- /v1/projects/{project}/sheets:
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ /v1/projects/{project}/savedQueries/organizers:batchUpdate:
post:
tags:
- - SheetService
- summary: CreateSheet
+ - SavedQueryService
+ summary: BatchUpdateSavedQueryOrganizer
description: |-
- Creates a new SQL sheet.
- Permissions required: bb.sheets.create
- operationId: SheetService_CreateSheet
+ Batch update the organizers of saved queries.
+ The access is the same as UpdateSavedQuery method.
+ Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ operationId: SavedQueryService_BatchUpdateSavedQueryOrganizer
parameters:
- name: project
in: path
@@ -13814,29 +13793,63 @@ paths:
schema:
type: string
requestBody:
- description: The sheet to create.
content:
application/json:
schema:
- title: sheet
- description: The sheet to create.
- $ref: '#/components/schemas/bytebase.v1.Sheet'
+ type: object
+ properties:
+ filter:
+ type: string
+ title: filter
+ description: |-
+ To filter the batch update target.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+ Supported filter:
+ - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ - folder: the saved query organizer folder path, support exact "==" operator.
+ organizer:
+ title: organizer
+ description: The organizer fields to update.
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
+ updateMask:
+ title: update_mask
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the saved query organizer.
+ Only support update the following fields for now:
+ - `starred`
+ - `folders`
+ $ref: '#/components/schemas/google.protobuf.FieldMask'
+ title: BatchUpdateSavedQueryOrganizerRequest
+ required:
+ - organizer
+ - updateMask
+ additionalProperties: false
+ required: true
responses:
"200":
description: Success
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Sheet'
- /v1/projects/{project}/sheets/{sheet}:
+ $ref: '#/components/schemas/bytebase.v1.BatchUpdateSavedQueryOrganizerResponse'
+ /v1/projects/{project}/savedQueries/{savedQuery}:
get:
tags:
- - SheetService
- summary: GetSheet
+ - SavedQueryService
+ summary: GetSavedQuery
description: |-
- Retrieves a SQL sheet by name.
- Permissions required: bb.sheets.get
- operationId: SheetService_GetSheet
+ Get a saved query by name.
+ The users can access this method if,
+ - they are the creator of the saved query;
+ - they have bb.worksheets.get permission on the workspace;
+ - the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ operationId: SavedQueryService_GetSavedQuery
parameters:
- name: project
in: path
@@ -13844,73 +13857,28 @@ paths:
required: true
schema:
type: string
- - name: sheet
- in: path
- description: The sheet id.
- required: true
- schema:
- type: string
- - name: raw
- in: query
- description: By default, the content of the sheet is cut off, set the `raw` to true to retrieve the full content.
- schema:
- type: boolean
- title: raw
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.Sheet'
- /v1/projects/{project}/sheets:batchCreate:
- post:
- tags:
- - SheetService
- summary: BatchCreateSheets
- description: |-
- Creates multiple SQL sheets in a single operation.
- Permissions required: bb.sheets.create
- operationId: SheetService_BatchCreateSheets
- parameters:
- - name: project
+ - name: savedQuery
in: path
- description: The project id.
+ description: The savedQuery id.
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- requests:
- type: array
- items:
- $ref: '#/components/schemas/bytebase.v1.CreateSheetRequest'
- title: requests
- title: BatchCreateSheetsRequest
- required:
- - requests
- additionalProperties: false
- required: true
responses:
"200":
description: Success
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.BatchCreateSheetsResponse'
- /v1/projects/{project}/webhooks/{webhook}:removeWebhook:
- post:
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ delete:
tags:
- - ProjectService
- summary: RemoveWebhook
+ - SavedQueryService
+ summary: DeleteSavedQuery
description: |-
- Removes a webhook from a project.
- Permissions required: bb.projects.update
- operationId: ProjectService_RemoveWebhook
+ Delete a saved query.
+ The access is the same as UpdateSavedQuery method.
+ Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ operationId: SavedQueryService_DeleteSavedQuery
parameters:
- name: project
in: path
@@ -13918,43 +13886,31 @@ paths:
required: true
schema:
type: string
- - name: webhook
+ - name: savedQuery
in: path
- description: The webhook id.
+ description: The savedQuery id.
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- webhook:
- title: webhook
- description: The webhook to remove. Identified by its url.
- $ref: '#/components/schemas/bytebase.v1.Webhook'
- title: RemoveWebhookRequest
- required:
- - webhook
- additionalProperties: false
- required: true
responses:
"200":
description: Success
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Project'
- /v1/projects/{project}/webhooks/{webhook}:updateWebhook:
+ $ref: '#/components/schemas/google.protobuf.Empty'
patch:
tags:
- - ProjectService
- summary: UpdateWebhook
+ - SavedQueryService
+ summary: UpdateSavedQuery
description: |-
- Updates an existing webhook configuration.
- Permissions required: bb.projects.update
- operationId: ProjectService_UpdateWebhook
+ Update a saved query.
+ The users can access this method if,
+ - they are the creator of the saved query;
+ - they have bb.worksheets.manage permission on the workspace;
+ - the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ operationId: SavedQueryService_UpdateSavedQuery
parameters:
- name: project
in: path
@@ -13962,9 +13918,9 @@ paths:
required: true
schema:
type: string
- - name: webhook
+ - name: savedQuery
in: path
- description: The webhook id.
+ description: The savedQuery id.
required: true
schema:
type: string
@@ -14172,39 +14128,39 @@ paths:
`INVALID_ARGUMENT` error if any path is unmappable.
schema:
type: string
- - name: allowMissing
- in: query
- description: |-
- If set to true, and the webhook is not found, a new webhook will be created.
- In this situation, `update_mask` is ignored.
- schema:
- type: boolean
- title: allow_missing
requestBody:
- description: The webhook to modify.
+ description: |-
+ The saved query to update.
+
+ The saved query's `name` field is used to identify the saved query to update.
+ Format: projects/{project}/savedQueries/{savedQuery}
content:
application/json:
schema:
- title: webhook
- description: The webhook to modify.
- $ref: '#/components/schemas/bytebase.v1.Webhook'
+ title: saved_query
+ description: |-
+ The saved query to update.
+
+ The saved query's `name` field is used to identify the saved query to update.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
responses:
"200":
description: Success
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Project'
- /v1/projects/{project}/workloadIdentities:
- get:
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ /v1/projects/{project}/savedQueries/{savedQuery}/organizer:
+ patch:
tags:
- - WorkloadIdentityService
- summary: ListWorkloadIdentities
+ - SavedQueryService
+ summary: UpdateSavedQueryOrganizer
description: |-
- Lists workload identities.
- For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.list on workspace.
- For project-level: parent is projects/{project}, permission bb.workloadIdentities.list on project.
- operationId: WorkloadIdentityService_ListWorkloadIdentities
+ Update the organizer of a saved query.
+ The access is the same as UpdateSavedQuery method.
+ Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ operationId: SavedQueryService_UpdateSavedQueryOrganizer
parameters:
- name: project
in: path
@@ -14212,369 +14168,16 @@ paths:
required: true
schema:
type: string
- - name: pageSize
- in: query
- description: |-
- The maximum number of workload identities to return. The service may return fewer than
- this value.
- If unspecified, at most 10 workload identities will be returned.
- The maximum value is 1000; values above 1000 will be coerced to 1000.
+ - name: savedQuery
+ in: path
+ description: The savedQuery id.
+ required: true
schema:
- type: integer
- title: page_size
- format: int32
- - name: pageToken
+ type: string
+ - name: updateMask
in: query
description: |-
- A page token, received from a previous `ListWorkloadIdentities` call.
- Provide this to retrieve the subsequent page.
-
- When paginating, all other parameters provided to `ListWorkloadIdentities` must match
- the call that provided the page token.
- schema:
- type: string
- title: page_token
- - name: showDeleted
- in: query
- description: Show deleted workload identities if specified.
- schema:
- type: boolean
- title: show_deleted
- - name: filter
- in: query
- description: |-
- Filter is used to filter workload identities returned in the list.
- The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
- Supported filter:
- - name: the workload identity name, support "==" and ".contains()" operator.
- - email: the workload identity email, support "==" and ".contains()" operator.
- - state: check State enum for values, support "==" operator.
-
- For example:
- name == "ed"
- name.contains("ed")
- state == "DELETED"
- email == "[email protected]"
- email.contains("ed")
- schema:
- type: string
- title: filter
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.ListWorkloadIdentitiesResponse'
- post:
- tags:
- - WorkloadIdentityService
- summary: CreateWorkloadIdentity
- description: |-
- Creates a new workload identity.
- For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.create on workspace.
- For project-level: parent is projects/{project}, permission bb.workloadIdentities.create on project.
- operationId: WorkloadIdentityService_CreateWorkloadIdentity
- parameters:
- - name: project
- in: path
- description: The project id.
- required: true
- schema:
- type: string
- - name: workloadIdentityId
- in: query
- description: |-
- The ID to use for the workload identity, which will become the final component
- of the workload identity's email in the format: {workload_identity_id}@workload.bytebase.com
- or {workload_identity_id}@{project-id}.workload.bytebase.com
- required: true
- schema:
- type: string
- title: workload_identity_id
- requestBody:
- description: The workload identity to create.
- content:
- application/json:
- schema:
- title: workload_identity
- description: The workload identity to create.
- $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
- /v1/projects/{project}/worksheetFolders:
- get:
- tags:
- - WorksheetService
- summary: ListWorksheetFolders
- description: |-
- List the caller's worksheet folders.
- Only folders stored in the caller's worksheet organizer are returned.
- operationId: WorksheetService_ListWorksheetFolders
- parameters:
- - name: project
- in: path
- description: The project id.
- required: true
- schema:
- type: string
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.ListWorksheetFoldersResponse'
- /v1/projects/{project}/worksheets:
- get:
- tags:
- - WorksheetService
- summary: ListWorksheets
- description: |-
- List worksheets.
- This is used for listing worksheets in a project, or across all projects by using `projects/-`.
- Permissions required: bb.worksheets.list
- operationId: WorksheetService_ListWorksheets
- parameters:
- - name: project
- in: path
- description: The project id.
- required: true
- schema:
- type: string
- - name: filter
- in: query
- description: |-
- To filter the list result.
- The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
- Supported filter:
- - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
-
- For example:
- creator == "users/{email}"
- creator != "users/{email}"
- schema:
- type: string
- title: filter
- - name: pageSize
- in: query
- description: |-
- The maximum number of worksheets to return. The service may return fewer than
- this value.
- If unspecified, at most 10 worksheets will be returned.
- The maximum value is 1000; values above 1000 will be coerced to 1000.
- schema:
- type: integer
- title: page_size
- format: int32
- - name: pageToken
- in: query
- description: |-
- A page token, received from a previous `ListWorksheets` call.
- Provide this to retrieve the subsequent page.
-
- When paginating, all other parameters provided to `ListWorksheets` must match
- the call that provided the page token.
- schema:
- type: string
- title: page_token
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.ListWorksheetsResponse'
- post:
- tags:
- - WorksheetService
- summary: CreateWorksheet
- description: |-
- Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
- Permissions required: None (authenticated users only)
- operationId: WorksheetService_CreateWorksheet
- parameters:
- - name: project
- in: path
- description: The project id.
- required: true
- schema:
- type: string
- requestBody:
- description: The worksheet to create.
- content:
- application/json:
- schema:
- title: worksheet
- description: The worksheet to create.
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- /v1/projects/{project}/worksheets/organizers:batchUpdate:
- post:
- tags:
- - WorksheetService
- summary: BatchUpdateWorksheetOrganizer
- description: |-
- Batch update the organizers of worksheets.
- The access is the same as UpdateWorksheet method.
- Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- operationId: WorksheetService_BatchUpdateWorksheetOrganizer
- parameters:
- - name: project
- in: path
- description: The project id.
- required: true
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- filter:
- type: string
- title: filter
- description: |-
- To filter the batch update target.
- The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
- Supported filter:
- - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- - folder: the worksheet organizer folder path, support exact "==" operator.
- organizer:
- title: organizer
- description: The organizer fields to update.
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
- updateMask:
- title: update_mask
- description: |-
- The list of fields to be updated.
- Fields are specified relative to the worksheet organizer.
- Only support update the following fields for now:
- - `starred`
- - `folders`
- $ref: '#/components/schemas/google.protobuf.FieldMask'
- title: BatchUpdateWorksheetOrganizerRequest
- required:
- - organizer
- - updateMask
- additionalProperties: false
- required: true
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.BatchUpdateWorksheetOrganizerResponse'
- /v1/projects/{project}/worksheets/{worksheet}:
- get:
- tags:
- - WorksheetService
- summary: GetWorksheet
- description: |-
- Get a worksheet by name.
- The users can access this method if,
- - they are the creator of the worksheet;
- - they have bb.worksheets.get permission on the workspace;
- - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- operationId: WorksheetService_GetWorksheet
- parameters:
- - name: project
- in: path
- description: The project id.
- required: true
- schema:
- type: string
- - name: worksheet
- in: path
- description: The worksheet id.
- required: true
- schema:
- type: string
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- delete:
- tags:
- - WorksheetService
- summary: DeleteWorksheet
- description: |-
- Delete a worksheet.
- The access is the same as UpdateWorksheet method.
- Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- operationId: WorksheetService_DeleteWorksheet
- parameters:
- - name: project
- in: path
- description: The project id.
- required: true
- schema:
- type: string
- - name: worksheet
- in: path
- description: The worksheet id.
- required: true
- schema:
- type: string
- responses:
- "200":
- description: Success
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/google.protobuf.Empty'
- patch:
- tags:
- - WorksheetService
- summary: UpdateWorksheet
- description: |-
- Update a worksheet.
- The users can access this method if,
- - they are the creator of the worksheet;
- - they have bb.worksheets.manage permission on the workspace;
- - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- operationId: WorksheetService_UpdateWorksheet
- parameters:
- - name: project
- in: path
- description: The project id.
- required: true
- schema:
- type: string
- - name: worksheet
- in: path
- description: The worksheet id.
- required: true
- schema:
- type: string
- - name: updateMask
- in: query
- description: |-
- `FieldMask` represents a set of symbolic field paths, for example:
+ `FieldMask` represents a set of symbolic field paths, for example:
paths: "f.a"
paths: "f.b.d"
@@ -14775,39 +14378,404 @@ paths:
`INVALID_ARGUMENT` error if any path is unmappable.
schema:
type: string
+ - name: allowMissing
+ in: query
+ description: |-
+ If set to true, and the saved query organizer is not found, a new saved query organizer will be created.
+ In this situation, `update_mask` is ignored.
+ schema:
+ type: boolean
+ title: allow_missing
+ requestBody:
+ description: |-
+ The organizer to update.
+
+ The organizer's `saved_query` field is used to identify the saved query.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ content:
+ application/json:
+ schema:
+ title: organizer
+ description: |-
+ The organizer to update.
+
+ The organizer's `saved_query` field is used to identify the saved query.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
+ /v1/projects/{project}/savedQueries:search:
+ post:
+ tags:
+ - SavedQueryService
+ summary: SearchSavedQueries
+ description: |-
+ Search for saved queries.
+ This is used for finding my saved queries or saved queries shared by other people.
+ The saved query accessibility is the same as GetSavedQuery().
+ Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ operationId: SavedQueryService_SearchSavedQueries
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ filter:
+ type: string
+ title: filter
+ description: |-
+ To filter the search result.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+ Supported filter:
+ - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ - title: the saved query title, support "contains" operator.
+ - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ - folder: the saved query organizer folder path, support "==" operator.
+
+ For example:
+ creator == "users/{email}"
+ title.contains("saved query title")
+ creator != "users/{email}"
+ starred == true
+ starred == false
+ visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
+ visibility == "PRIVATE"
+ folder == "foo/bar"
+ pageSize:
+ type: integer
+ title: page_size
+ format: int32
+ description: |-
+ The maximum number of saved queries to return. The service may return fewer than
+ this value.
+ If unspecified, at most 10 saved queries will be returned.
+ The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken:
+ type: string
+ title: page_token
+ description: |-
+ A page token, received from a previous `SearchSavedQueries` call.
+ Provide this to retrieve the subsequent page.
+ title: SearchSavedQueriesRequest
+ additionalProperties: false
+ required: true
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.SearchSavedQueriesResponse'
+ /v1/projects/{project}/savedQueryFolders:
+ get:
+ tags:
+ - SavedQueryService
+ summary: ListSavedQueryFolders
+ description: |-
+ List the caller's saved query folders.
+ Only folders stored in the caller's saved query organizer are returned.
+ operationId: SavedQueryService_ListSavedQueryFolders
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.ListSavedQueryFoldersResponse'
+ /v1/projects/{project}/serviceAccounts:
+ get:
+ tags:
+ - ServiceAccountService
+ summary: ListServiceAccounts
+ description: |-
+ Lists service accounts.
+ For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.list on workspace.
+ For project-level: parent is projects/{project}, permission bb.serviceAccounts.list on project.
+ operationId: ServiceAccountService_ListServiceAccounts
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ - name: pageSize
+ in: query
+ description: |-
+ The maximum number of service accounts to return. The service may return fewer than
+ this value.
+ If unspecified, at most 10 service accounts will be returned.
+ The maximum value is 1000; values above 1000 will be coerced to 1000.
+ schema:
+ type: integer
+ title: page_size
+ format: int32
+ - name: pageToken
+ in: query
+ description: |-
+ A page token, received from a previous `ListServiceAccounts` call.
+ Provide this to retrieve the subsequent page.
+
+ When paginating, all other parameters provided to `ListServiceAccounts` must match
+ the call that provided the page token.
+ schema:
+ type: string
+ title: page_token
+ - name: showDeleted
+ in: query
+ description: Show deleted service accounts if specified.
+ schema:
+ type: boolean
+ title: show_deleted
+ - name: filter
+ in: query
+ description: |-
+ Filter is used to filter service accounts returned in the list.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+ Supported filter:
+ - name: the service account name, support "==" and ".contains()" operator.
+ - email: the service account email, support "==" and ".contains()" operator.
+ - state: check State enum for values, support "==" operator.
+
+ For example:
+ name == "ed"
+ name.contains("ed")
+ state == "DELETED"
+ email == "[email protected]"
+ email.contains("ed")
+ schema:
+ type: string
+ title: filter
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.ListServiceAccountsResponse'
+ post:
+ tags:
+ - ServiceAccountService
+ summary: CreateServiceAccount
+ description: |-
+ Creates a new service account.
+ For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.create on workspace.
+ For project-level: parent is projects/{project}, permission bb.serviceAccounts.create on project.
+ operationId: ServiceAccountService_CreateServiceAccount
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ - name: serviceAccountId
+ in: query
+ description: |-
+ The ID to use for the service account, which will become the final component
+ of the service account's email in the format: {service_account_id}@service.bytebase.com
+ or {service_account_id}@{project-id}.service.bytebase.com
+ required: true
+ schema:
+ type: string
+ title: service_account_id
+ requestBody:
+ description: The service account to create.
+ content:
+ application/json:
+ schema:
+ title: service_account
+ description: The service account to create.
+ $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.ServiceAccount'
+ /v1/projects/{project}/sheets:
+ post:
+ tags:
+ - SheetService
+ summary: CreateSheet
+ description: |-
+ Creates a new SQL sheet.
+ Permissions required: bb.sheets.create
+ operationId: SheetService_CreateSheet
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
requestBody:
- description: |-
- The worksheet to update.
-
- The worksheet's `name` field is used to identify the worksheet to update.
- Format: projects/{project}/worksheets/{worksheet}
+ description: The sheet to create.
content:
application/json:
schema:
- title: worksheet
- description: |-
- The worksheet to update.
-
- The worksheet's `name` field is used to identify the worksheet to update.
- Format: projects/{project}/worksheets/{worksheet}
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
+ title: sheet
+ description: The sheet to create.
+ $ref: '#/components/schemas/bytebase.v1.Sheet'
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.Sheet'
+ /v1/projects/{project}/sheets/{sheet}:
+ get:
+ tags:
+ - SheetService
+ summary: GetSheet
+ description: |-
+ Retrieves a SQL sheet by name.
+ Permissions required: bb.sheets.get
+ operationId: SheetService_GetSheet
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ - name: sheet
+ in: path
+ description: The sheet id.
+ required: true
+ schema:
+ type: string
+ - name: raw
+ in: query
+ description: By default, the content of the sheet is cut off, set the `raw` to true to retrieve the full content.
+ schema:
+ type: boolean
+ title: raw
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.Sheet'
+ /v1/projects/{project}/sheets:batchCreate:
+ post:
+ tags:
+ - SheetService
+ summary: BatchCreateSheets
+ description: |-
+ Creates multiple SQL sheets in a single operation.
+ Permissions required: bb.sheets.create
+ operationId: SheetService_BatchCreateSheets
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ requests:
+ type: array
+ items:
+ $ref: '#/components/schemas/bytebase.v1.CreateSheetRequest'
+ title: requests
+ title: BatchCreateSheetsRequest
+ required:
+ - requests
+ additionalProperties: false
+ required: true
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.BatchCreateSheetsResponse'
+ /v1/projects/{project}/webhooks/{webhook}:removeWebhook:
+ post:
+ tags:
+ - ProjectService
+ summary: RemoveWebhook
+ description: |-
+ Removes a webhook from a project.
+ Permissions required: bb.projects.update
+ operationId: ProjectService_RemoveWebhook
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ - name: webhook
+ in: path
+ description: The webhook id.
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ webhook:
+ title: webhook
+ description: The webhook to remove. Identified by its url.
+ $ref: '#/components/schemas/bytebase.v1.Webhook'
+ title: RemoveWebhookRequest
+ required:
+ - webhook
+ additionalProperties: false
+ required: true
responses:
"200":
description: Success
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- /v1/projects/{project}/worksheets/{worksheet}/organizer:
+ $ref: '#/components/schemas/bytebase.v1.Project'
+ /v1/projects/{project}/webhooks/{webhook}:updateWebhook:
patch:
tags:
- - WorksheetService
- summary: UpdateWorksheetOrganizer
+ - ProjectService
+ summary: UpdateWebhook
description: |-
- Update the organizer of a worksheet.
- The access is the same as UpdateWorksheet method.
- Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- operationId: WorksheetService_UpdateWorksheetOrganizer
+ Updates an existing webhook configuration.
+ Permissions required: bb.projects.update
+ operationId: ProjectService_UpdateWebhook
parameters:
- name: project
in: path
@@ -14815,9 +14783,9 @@ paths:
required: true
schema:
type: string
- - name: worksheet
+ - name: webhook
in: path
- description: The worksheet id.
+ description: The webhook id.
required: true
schema:
type: string
@@ -15028,45 +14996,36 @@ paths:
- name: allowMissing
in: query
description: |-
- If set to true, and the worksheet organizer is not found, a new worksheet organizer will be created.
+ If set to true, and the webhook is not found, a new webhook will be created.
In this situation, `update_mask` is ignored.
schema:
type: boolean
title: allow_missing
requestBody:
- description: |-
- The organizer to update.
-
- The organizer's `worksheet` field is used to identify the worksheet.
- Format: projects/{project}/worksheets/{worksheet}
+ description: The webhook to modify.
content:
application/json:
schema:
- title: organizer
- description: |-
- The organizer to update.
-
- The organizer's `worksheet` field is used to identify the worksheet.
- Format: projects/{project}/worksheets/{worksheet}
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
+ title: webhook
+ description: The webhook to modify.
+ $ref: '#/components/schemas/bytebase.v1.Webhook'
responses:
"200":
description: Success
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
- /v1/projects/{project}/worksheets:search:
- post:
+ $ref: '#/components/schemas/bytebase.v1.Project'
+ /v1/projects/{project}/workloadIdentities:
+ get:
tags:
- - WorksheetService
- summary: SearchWorksheets
+ - WorkloadIdentityService
+ summary: ListWorkloadIdentities
description: |-
- Search for worksheets.
- This is used for finding my worksheets or worksheets shared by other people.
- The sheet accessibility is the same as GetWorksheet().
- Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- operationId: WorksheetService_SearchWorksheets
+ Lists workload identities.
+ For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.list on workspace.
+ For project-level: parent is projects/{project}, permission bb.workloadIdentities.list on project.
+ operationId: WorkloadIdentityService_ListWorkloadIdentities
parameters:
- name: project
in: path
@@ -15074,61 +15033,102 @@ paths:
required: true
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- filter:
- type: string
- title: filter
- description: |-
- To filter the search result.
- The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ - name: pageSize
+ in: query
+ description: |-
+ The maximum number of workload identities to return. The service may return fewer than
+ this value.
+ If unspecified, at most 10 workload identities will be returned.
+ The maximum value is 1000; values above 1000 will be coerced to 1000.
+ schema:
+ type: integer
+ title: page_size
+ format: int32
+ - name: pageToken
+ in: query
+ description: |-
+ A page token, received from a previous `ListWorkloadIdentities` call.
+ Provide this to retrieve the subsequent page.
- Supported filter:
- - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- - title: the worksheet title, support "contains" operator.
- - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- - folder: the worksheet organizer folder path, support "==" operator.
+ When paginating, all other parameters provided to `ListWorkloadIdentities` must match
+ the call that provided the page token.
+ schema:
+ type: string
+ title: page_token
+ - name: showDeleted
+ in: query
+ description: Show deleted workload identities if specified.
+ schema:
+ type: boolean
+ title: show_deleted
+ - name: filter
+ in: query
+ description: |-
+ Filter is used to filter workload identities returned in the list.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- For example:
- creator == "users/{email}"
- title.contains("worksheet title")
- creator != "users/{email}"
- starred == true
- starred == false
- visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
- visibility == "PRIVATE"
- folder == "foo/bar"
- pageSize:
- type: integer
- title: page_size
- format: int32
- description: |-
- The maximum number of worksheets to return. The service may return fewer than
- this value.
- If unspecified, at most 10 worksheets will be returned.
- The maximum value is 1000; values above 1000 will be coerced to 1000.
- pageToken:
- type: string
- title: page_token
- description: |-
- A page token, received from a previous `SearchWorksheets` call.
- Provide this to retrieve the subsequent page.
- title: SearchWorksheetsRequest
- additionalProperties: false
- required: true
+ Supported filter:
+ - name: the workload identity name, support "==" and ".contains()" operator.
+ - email: the workload identity email, support "==" and ".contains()" operator.
+ - state: check State enum for values, support "==" operator.
+
+ For example:
+ name == "ed"
+ name.contains("ed")
+ state == "DELETED"
+ email == "[email protected]"
+ email.contains("ed")
+ schema:
+ type: string
+ title: filter
+ responses:
+ "200":
+ description: Success
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/bytebase.v1.ListWorkloadIdentitiesResponse'
+ post:
+ tags:
+ - WorkloadIdentityService
+ summary: CreateWorkloadIdentity
+ description: |-
+ Creates a new workload identity.
+ For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.create on workspace.
+ For project-level: parent is projects/{project}, permission bb.workloadIdentities.create on project.
+ operationId: WorkloadIdentityService_CreateWorkloadIdentity
+ parameters:
+ - name: project
+ in: path
+ description: The project id.
+ required: true
+ schema:
+ type: string
+ - name: workloadIdentityId
+ in: query
+ description: |-
+ The ID to use for the workload identity, which will become the final component
+ of the workload identity's email in the format: {workload_identity_id}@workload.bytebase.com
+ or {workload_identity_id}@{project-id}.workload.bytebase.com
+ required: true
+ schema:
+ type: string
+ title: workload_identity_id
+ requestBody:
+ description: The workload identity to create.
+ content:
+ application/json:
+ schema:
+ title: workload_identity
+ description: The workload identity to create.
+ $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
responses:
"200":
description: Success
content:
application/json:
schema:
- $ref: '#/components/schemas/bytebase.v1.SearchWorksheetsResponse'
+ $ref: '#/components/schemas/bytebase.v1.WorkloadIdentity'
/v1/projects/{project}:addWebhook:
post:
tags:
@@ -20242,14 +20242,14 @@ components:
type: object
title: BatchUpdateIssuesStatusResponse
additionalProperties: false
- bytebase.v1.BatchUpdateWorksheetOrganizerRequest:
+ bytebase.v1.BatchUpdateSavedQueryOrganizerRequest:
type: object
properties:
parent:
type: string
title: parent
description: |-
- The parent resource whose worksheets' organizers are updated.
+ The parent resource whose saved queries' organizers are updated.
Format: projects/{project}
filter:
type: string
@@ -20259,43 +20259,43 @@ components:
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
- - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- - folder: the worksheet organizer folder path, support exact "==" operator.
+ - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ - folder: the saved query organizer folder path, support exact "==" operator.
organizer:
title: organizer
description: The organizer fields to update.
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
updateMask:
title: update_mask
description: |-
The list of fields to be updated.
- Fields are specified relative to the worksheet organizer.
+ Fields are specified relative to the saved query organizer.
Only support update the following fields for now:
- `starred`
- `folders`
$ref: '#/components/schemas/google.protobuf.FieldMask'
- title: BatchUpdateWorksheetOrganizerRequest
+ title: BatchUpdateSavedQueryOrganizerRequest
required:
- parent
- organizer
- updateMask
additionalProperties: false
- bytebase.v1.BatchUpdateWorksheetOrganizerResponse:
+ bytebase.v1.BatchUpdateSavedQueryOrganizerResponse:
type: object
properties:
- worksheetOrganizers:
+ savedQueryOrganizers:
type: array
items:
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
- title: worksheet_organizers
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
+ title: saved_query_organizers
updatedCount:
type: integer
title: updated_count
format: int32
- title: BatchUpdateWorksheetOrganizerResponse
+ title: BatchUpdateSavedQueryOrganizerResponse
additionalProperties: false
bytebase.v1.BillingInterval:
type: string
@@ -21168,6 +21168,24 @@ components:
required:
- parent
additionalProperties: false
+ bytebase.v1.CreateSavedQueryRequest:
+ type: object
+ properties:
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource where this saved query will be created.
+ Format: projects/{project}
+ savedQuery:
+ title: saved_query
+ description: The saved query to create.
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ title: CreateSavedQueryRequest
+ required:
+ - parent
+ - savedQuery
+ additionalProperties: false
bytebase.v1.CreateServiceAccountRequest:
type: object
properties:
@@ -21249,24 +21267,6 @@ components:
- workloadIdentity
additionalProperties: false
description: Request message for creating a workload identity.
- bytebase.v1.CreateWorksheetRequest:
- type: object
- properties:
- parent:
- type: string
- title: parent
- description: |-
- The parent resource where this worksheet will be created.
- Format: projects/{project}
- worksheet:
- title: worksheet
- description: The worksheet to create.
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- title: CreateWorksheetRequest
- required:
- - parent
- - worksheet
- additionalProperties: false
bytebase.v1.DataClassificationSetting:
type: object
properties:
@@ -22270,6 +22270,19 @@ components:
required:
- name
additionalProperties: false
+ bytebase.v1.DeleteSavedQueryRequest:
+ type: object
+ properties:
+ name:
+ type: string
+ title: name
+ description: |-
+ The name of the saved query to delete.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ title: DeleteSavedQueryRequest
+ required:
+ - name
+ additionalProperties: false
bytebase.v1.DeleteServiceAccountRequest:
type: object
properties:
@@ -22311,19 +22324,6 @@ components:
- name
additionalProperties: false
description: Request message for deleting a workload identity.
- bytebase.v1.DeleteWorksheetRequest:
- type: object
- properties:
- name:
- type: string
- title: name
- description: |-
- The name of the worksheet to delete.
- Format: projects/{project}/worksheets/{worksheet}
- title: DeleteWorksheetRequest
- required:
- - name
- additionalProperties: false
bytebase.v1.DeleteWorkspaceRequest:
type: object
properties:
@@ -23444,6 +23444,19 @@ components:
required:
- name
additionalProperties: false
+ bytebase.v1.GetSavedQueryRequest:
+ type: object
+ properties:
+ name:
+ type: string
+ title: name
+ description: |-
+ The name of the saved query to retrieve.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ title: GetSavedQueryRequest
+ required:
+ - name
+ additionalProperties: false
bytebase.v1.GetSchemaStringRequest:
type: object
properties:
@@ -23611,19 +23624,6 @@ components:
- name
additionalProperties: false
description: Request message for getting a workload identity.
- bytebase.v1.GetWorksheetRequest:
- type: object
- properties:
- name:
- type: string
- title: name
- description: |-
- The name of the worksheet to retrieve.
- Format: projects/{project}/worksheets/{worksheet}
- title: GetWorksheetRequest
- required:
- - name
- additionalProperties: false
bytebase.v1.GetWorkspaceRequest:
type: object
properties:
@@ -25675,6 +25675,93 @@ components:
If this field is omitted, there are no subsequent pages.
title: ListRolloutsResponse
additionalProperties: false
+ bytebase.v1.ListSavedQueriesRequest:
+ type: object
+ properties:
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource of the saved queries.
+ Format: projects/{project}
+ Use "projects/-" to list saved queries across all projects.
+ filter:
+ type: string
+ title: filter
+ description: |-
+ To filter the list result.
+ The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+ Supported filter:
+ - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+
+ For example:
+ creator == "users/{email}"
+ creator != "users/{email}"
+ pageSize:
+ type: integer
+ title: page_size
+ format: int32
+ description: |-
+ The maximum number of saved queries to return. The service may return fewer than
+ this value.
+ If unspecified, at most 10 saved queries will be returned.
+ The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken:
+ type: string
+ title: page_token
+ description: |-
+ A page token, received from a previous `ListSavedQueries` call.
+ Provide this to retrieve the subsequent page.
+
+ When paginating, all other parameters provided to `ListSavedQueries` must match
+ the call that provided the page token.
+ title: ListSavedQueriesRequest
+ required:
+ - parent
+ additionalProperties: false
+ bytebase.v1.ListSavedQueriesResponse:
+ type: object
+ properties:
+ savedQueries:
+ type: array
+ items:
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ title: saved_queries
+ description: The saved queries from the specified parent.
+ nextPageToken:
+ type: string
+ title: next_page_token
+ description: |-
+ A token to retrieve next page of saved queries.
+ Pass this value in the page_token field in the subsequent call to
+ `ListSavedQueries` method to retrieve the next page of saved queries.
+ title: ListSavedQueriesResponse
+ additionalProperties: false
+ bytebase.v1.ListSavedQueryFoldersRequest:
+ type: object
+ properties:
+ parent:
+ type: string
+ title: parent
+ description: |-
+ The parent resource of the saved query folders.
+ Format: projects/{project}
+ title: ListSavedQueryFoldersRequest
+ required:
+ - parent
+ additionalProperties: false
+ bytebase.v1.ListSavedQueryFoldersResponse:
+ type: object
+ properties:
+ folders:
+ type: array
+ items:
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryFolder'
+ title: folders
+ description: The caller's saved query folders.
+ title: ListSavedQueryFoldersResponse
+ additionalProperties: false
bytebase.v1.ListServiceAccountsRequest:
type: object
properties:
@@ -25922,93 +26009,6 @@ components:
title: ListWorkloadIdentitiesResponse
additionalProperties: false
description: Response message for listing workload identities.
- bytebase.v1.ListWorksheetFoldersRequest:
- type: object
- properties:
- parent:
- type: string
- title: parent
- description: |-
- The parent resource of the worksheet folders.
- Format: projects/{project}
- title: ListWorksheetFoldersRequest
- required:
- - parent
- additionalProperties: false
- bytebase.v1.ListWorksheetFoldersResponse:
- type: object
- properties:
- folders:
- type: array
- items:
- $ref: '#/components/schemas/bytebase.v1.WorksheetFolder'
- title: folders
- description: The caller's worksheet folders.
- title: ListWorksheetFoldersResponse
- additionalProperties: false
- bytebase.v1.ListWorksheetsRequest:
- type: object
- properties:
- parent:
- type: string
- title: parent
- description: |-
- The parent resource of the worksheets.
- Format: projects/{project}
- Use "projects/-" to list worksheets across all projects.
- filter:
- type: string
- title: filter
- description: |-
- To filter the list result.
- The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
- Supported filter:
- - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
-
- For example:
- creator == "users/{email}"
- creator != "users/{email}"
- pageSize:
- type: integer
- title: page_size
- format: int32
- description: |-
- The maximum number of worksheets to return. The service may return fewer than
- this value.
- If unspecified, at most 10 worksheets will be returned.
- The maximum value is 1000; values above 1000 will be coerced to 1000.
- pageToken:
- type: string
- title: page_token
- description: |-
- A page token, received from a previous `ListWorksheets` call.
- Provide this to retrieve the subsequent page.
-
- When paginating, all other parameters provided to `ListWorksheets` must match
- the call that provided the page token.
- title: ListWorksheetsRequest
- required:
- - parent
- additionalProperties: false
- bytebase.v1.ListWorksheetsResponse:
- type: object
- properties:
- worksheets:
- type: array
- items:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- title: worksheets
- description: The worksheets from the specified parent.
- nextPageToken:
- type: string
- title: next_page_token
- description: |-
- A token to retrieve next page of worksheets.
- Pass this value in the page_token field in the subsequent call to
- `ListWorksheets` method to retrieve the next page of worksheets.
- title: ListWorksheetsResponse
- additionalProperties: false
bytebase.v1.ListWorkspacesRequest:
type: object
title: ListWorkspacesRequest
@@ -28965,6 +28965,142 @@ components:
- BUILTIN_WALK_THROUGH_CHECK
- STATEMENT_DISALLOW_TRUNCATE
- BUILTIN_STATEMENT_MAXIMUM_SQL_SIZE
+ bytebase.v1.SavedQuery:
+ type: object
+ properties:
+ name:
+ type: string
+ title: name
+ description: |-
+ (IMMUTABLE) The name of the saved query resource, generated by the server.
+ Canonical parent is project.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ project:
+ type: string
+ title: project
+ description: |-
+ The project resource name.
+ Format: projects/{project}
+ readOnly: true
+ database:
+ type: string
+ title: database
+ description: |-
+ The database resource name.
+ Format: instances/{instance}/databases/{database}
+ If the database parent doesn't exist, the database field is empty.
+ title:
+ type: string
+ title: title
+ maxLength: 200
+ description: The title of the saved query.
+ creator:
+ type: string
+ title: creator
+ description: |-
+ The creator of the SavedQuery.
+ Format: users/{email}
+ readOnly: true
+ createTime:
+ title: create_time
+ description: The create time of the saved query.
+ readOnly: true
+ $ref: '#/components/schemas/google.protobuf.Timestamp'
+ updateTime:
+ title: update_time
+ description: The last update time of the saved query.
+ readOnly: true
+ $ref: '#/components/schemas/google.protobuf.Timestamp'
+ content:
+ type: string
+ title: content
+ format: byte
+ description: |-
+ The content of the saved query.
+ By default, it will be cut off in SearchSavedQueries() method. If it doesn't match the `content_size`, you can
+ use GetSavedQuery() request to retrieve the full content.
+ contentSize:
+ type:
+ - integer
+ - string
+ title: content_size
+ format: int64
+ description: content_size is the full size of the content, may not match the size of the `content` field.
+ readOnly: true
+ visibility:
+ title: visibility
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery.Visibility'
+ starred:
+ type: boolean
+ title: starred
+ description: starred indicates whether the saved query is starred by the current authenticated user.
+ readOnly: true
+ folders:
+ type: array
+ items:
+ type: string
+ readOnly: true
+ title: folders
+ readOnly: true
+ title: SavedQuery
+ required:
+ - name
+ - title
+ - content
+ - visibility
+ additionalProperties: false
+ bytebase.v1.SavedQuery.Visibility:
+ type: string
+ title: Visibility
+ enum:
+ - VISIBILITY_UNSPECIFIED
+ - PROJECT_READ
+ - PROJECT_WRITE
+ - PRIVATE
+ bytebase.v1.SavedQueryFolder:
+ type: object
+ properties:
+ folders:
+ type: array
+ items:
+ type: string
+ title: folders
+ description: The folder path segments.
+ category:
+ title: category
+ description: The folder category.
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryFolder.Category'
+ title: SavedQueryFolder
+ additionalProperties: false
+ bytebase.v1.SavedQueryFolder.Category:
+ type: string
+ title: Category
+ enum:
+ - CATEGORY_UNSPECIFIED
+ - MINE
+ - SHARED
+ bytebase.v1.SavedQueryOrganizer:
+ type: object
+ properties:
+ savedQuery:
+ type: string
+ title: saved_query
+ description: |-
+ The name of the saved query.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ starred:
+ type: boolean
+ title: starred
+ description: starred means if the saved query is starred.
+ folders:
+ type: array
+ items:
+ type: string
+ title: folders
+ title: SavedQueryOrganizer
+ required:
+ - savedQuery
+ additionalProperties: false
bytebase.v1.SchemaCatalog:
type: object
properties:
@@ -29437,14 +29573,14 @@ components:
`ListQueryHistory` method to retrieve the next page of history.
title: SearchQueryHistoriesResponse
additionalProperties: false
- bytebase.v1.SearchWorksheetsRequest:
+ bytebase.v1.SearchSavedQueriesRequest:
type: object
properties:
parent:
type: string
title: parent
description: |-
- The parent resource of the worksheets.
+ The parent resource of the saved queries.
Format: projects/{project}
filter:
type: string
@@ -29454,16 +29590,16 @@ components:
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
- - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- - title: the worksheet title, support "contains" operator.
- - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- - folder: the worksheet organizer folder path, support "==" operator.
+ - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ - title: the saved query title, support "contains" operator.
+ - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ - folder: the saved query organizer folder path, support "==" operator.
For example:
creator == "users/{email}"
- title.contains("worksheet title")
+ title.contains("saved query title")
creator != "users/{email}"
starred == true
starred == false
@@ -29475,37 +29611,37 @@ components:
title: page_size
format: int32
description: |-
- The maximum number of worksheets to return. The service may return fewer than
+ The maximum number of saved queries to return. The service may return fewer than
this value.
- If unspecified, at most 10 worksheets will be returned.
+ If unspecified, at most 10 saved queries will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken:
type: string
title: page_token
description: |-
- A page token, received from a previous `SearchWorksheets` call.
+ A page token, received from a previous `SearchSavedQueries` call.
Provide this to retrieve the subsequent page.
- title: SearchWorksheetsRequest
+ title: SearchSavedQueriesRequest
required:
- parent
additionalProperties: false
- bytebase.v1.SearchWorksheetsResponse:
+ bytebase.v1.SearchSavedQueriesResponse:
type: object
properties:
- worksheets:
+ savedQueries:
type: array
items:
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- title: worksheets
- description: The worksheets that matched the search criteria.
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ title: saved_queries
+ description: The saved queries that matched the search criteria.
nextPageToken:
type: string
title: next_page_token
description: |-
- A token to retrieve next page of worksheets.
+ A token to retrieve next page of saved queries.
Pass this value in the page_token field in the subsequent call to
- `SearchWorksheets` method to retrieve the next page of worksheets.
- title: SearchWorksheetsResponse
+ `SearchSavedQueries` method to retrieve the next page of saved queries.
+ title: SearchSavedQueriesResponse
additionalProperties: false
bytebase.v1.SemanticTypeSetting:
type: object
@@ -31908,6 +32044,62 @@ components:
required:
- role
additionalProperties: false
+ bytebase.v1.UpdateSavedQueryOrganizerRequest:
+ type: object
+ properties:
+ organizer:
+ title: organizer
+ description: |-
+ The organizer to update.
+
+ The organizer's `saved_query` field is used to identify the saved query.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ $ref: '#/components/schemas/bytebase.v1.SavedQueryOrganizer'
+ updateMask:
+ title: update_mask
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the saved query organizer.
+ Only support update the following fields for now:
+ - `starred`
+ $ref: '#/components/schemas/google.protobuf.FieldMask'
+ allowMissing:
+ type: boolean
+ title: allow_missing
+ description: |-
+ If set to true, and the saved query organizer is not found, a new saved query organizer will be created.
+ In this situation, `update_mask` is ignored.
+ title: UpdateSavedQueryOrganizerRequest
+ required:
+ - organizer
+ additionalProperties: false
+ bytebase.v1.UpdateSavedQueryRequest:
+ type: object
+ properties:
+ savedQuery:
+ title: saved_query
+ description: |-
+ The saved query to update.
+
+ The saved query's `name` field is used to identify the saved query to update.
+ Format: projects/{project}/savedQueries/{savedQuery}
+ $ref: '#/components/schemas/bytebase.v1.SavedQuery'
+ updateMask:
+ title: update_mask
+ description: |-
+ The list of fields to be updated.
+ Fields are specified relative to the saved query.
+ (e.g., `title`, `statement`; *not* `saved_query.title` or `saved_query.statement`)
+ Only support update the following fields for now:
+ - `title`
+ - `statement`
+ - `starred`
+ - `visibility`
+ $ref: '#/components/schemas/google.protobuf.FieldMask'
+ title: UpdateSavedQueryRequest
+ required:
+ - savedQuery
+ additionalProperties: false
bytebase.v1.UpdateServiceAccountRequest:
type: object
properties:
@@ -32038,62 +32230,6 @@ components:
- workloadIdentity
additionalProperties: false
description: Request message for updating a workload identity.
- bytebase.v1.UpdateWorksheetOrganizerRequest:
- type: object
- properties:
- organizer:
- title: organizer
- description: |-
- The organizer to update.
-
- The organizer's `worksheet` field is used to identify the worksheet.
- Format: projects/{project}/worksheets/{worksheet}
- $ref: '#/components/schemas/bytebase.v1.WorksheetOrganizer'
- updateMask:
- title: update_mask
- description: |-
- The list of fields to be updated.
- Fields are specified relative to the worksheet organizer.
- Only support update the following fields for now:
- - `starred`
- $ref: '#/components/schemas/google.protobuf.FieldMask'
- allowMissing:
- type: boolean
- title: allow_missing
- description: |-
- If set to true, and the worksheet organizer is not found, a new worksheet organizer will be created.
- In this situation, `update_mask` is ignored.
- title: UpdateWorksheetOrganizerRequest
- required:
- - organizer
- additionalProperties: false
- bytebase.v1.UpdateWorksheetRequest:
- type: object
- properties:
- worksheet:
- title: worksheet
- description: |-
- The worksheet to update.
-
- The worksheet's `name` field is used to identify the worksheet to update.
- Format: projects/{project}/worksheets/{worksheet}
- $ref: '#/components/schemas/bytebase.v1.Worksheet'
- updateMask:
- title: update_mask
- description: |-
- The list of fields to be updated.
- Fields are specified relative to the worksheet.
- (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)
- Only support update the following fields for now:
- - `title`
- - `statement`
- - `starred`
- - `visibility`
- $ref: '#/components/schemas/google.protobuf.FieldMask'
- title: UpdateWorksheetRequest
- required:
- - worksheet
- additionalProperties: false
bytebase.v1.UpdateWorkspaceRequest:
type: object
properties:
@@ -32430,142 +32566,6 @@ components:
- GITHUB
- GITLAB
description: ProviderType identifies the CI/CD platform.
- bytebase.v1.Worksheet:
- type: object
- properties:
- name:
- type: string
- title: name
- description: |-
- (IMMUTABLE) The name of the worksheet resource, generated by the server.
- Canonical parent is project.
- Format: projects/{project}/worksheets/{worksheet}
- project:
- type: string
- title: project
- description: |-
- The project resource name.
- Format: projects/{project}
- readOnly: true
- database:
- type: string
- title: database
- description: |-
- The database resource name.
- Format: instances/{instance}/databases/{database}
- If the database parent doesn't exist, the database field is empty.
- title:
- type: string
- title: title
- maxLength: 200
- description: The title of the worksheet.
- creator:
- type: string
- title: creator
- description: |-
- The creator of the Worksheet.
- Format: users/{email}
- readOnly: true
- createTime:
- title: create_time
- description: The create time of the worksheet.
- readOnly: true
- $ref: '#/components/schemas/google.protobuf.Timestamp'
- updateTime:
- title: update_time
- description: The last update time of the worksheet.
- readOnly: true
- $ref: '#/components/schemas/google.protobuf.Timestamp'
- content:
- type: string
- title: content
- format: byte
- description: |-
- The content of the worksheet.
- By default, it will be cut off in SearchWorksheet() method. If it doesn't match the `content_size`, you can
- use GetWorksheet() request to retrieve the full content.
- contentSize:
- type:
- - integer
- - string
- title: content_size
- format: int64
- description: content_size is the full size of the content, may not match the size of the `content` field.
- readOnly: true
- visibility:
- title: visibility
- $ref: '#/components/schemas/bytebase.v1.Worksheet.Visibility'
- starred:
- type: boolean
- title: starred
- description: starred indicates whether the worksheet is starred by the current authenticated user.
- readOnly: true
- folders:
- type: array
- items:
- type: string
- readOnly: true
- title: folders
- readOnly: true
- title: Worksheet
- required:
- - name
- - title
- - content
- - visibility
- additionalProperties: false
- bytebase.v1.Worksheet.Visibility:
- type: string
- title: Visibility
- enum:
- - VISIBILITY_UNSPECIFIED
- - PROJECT_READ
- - PROJECT_WRITE
- - PRIVATE
- bytebase.v1.WorksheetFolder:
- type: object
- properties:
- folders:
- type: array
- items:
- type: string
- title: folders
- description: The folder path segments.
- category:
- title: category
- description: The folder category.
- $ref: '#/components/schemas/bytebase.v1.WorksheetFolder.Category'
- title: WorksheetFolder
- additionalProperties: false
- bytebase.v1.WorksheetFolder.Category:
- type: string
- title: Category
- enum:
- - CATEGORY_UNSPECIFIED
- - MINE
- - SHARED
- bytebase.v1.WorksheetOrganizer:
- type: object
- properties:
- worksheet:
- type: string
- title: worksheet
- description: |-
- The name of the worksheet.
- Format: projects/{project}/worksheets/{worksheet}
- starred:
- type: boolean
- title: starred
- description: starred means if the worksheet is starred.
- folders:
- type: array
- items:
- type: string
- title: folders
- title: WorksheetOrganizer
- required:
- - worksheet
- additionalProperties: false
bytebase.v1.Workspace:
type: object
properties:
@@ -34224,6 +34224,11 @@ tags:
description: RevisionService manages schema revision history.
- name: RoleService
description: RoleService manages workspace roles and permissions.
+ - name: SavedQueryService
+ description: |-
+ SavedQueryService manages saved queries for SQL Editor query development.
+ Permission IDs still use the legacy `bb.worksheets.*` names; they are
+ renamed together with the access-model redesign and its role migration.
- name: ServiceAccountService
description: ServiceAccountService manages service accounts for API integrations.
- name: SheetService
@@ -34232,7 +34237,5 @@ tags:
description: SubscriptionService manages enterprise subscriptions and licensing.
- name: WorkloadIdentityService
description: WorkloadIdentityService manages workload identities for external CI/CD integrations.
- - name: WorksheetService
- description: WorksheetService manages SQL worksheets for query development.
- name: WorkspaceService
description: WorkspaceService manages workspace-level operations and profile.
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index aca89cce73..501dfaa0e0 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -676,6 +676,29 @@
- [RoleService](#bytebase-v1-RoleService)
+- [v1/saved_query_service.proto](#v1_saved_query_service-proto)
+ - [BatchUpdateSavedQueryOrganizerRequest](#bytebase-v1-BatchUpdateSavedQueryOrganizerRequest)
+ - [BatchUpdateSavedQueryOrganizerResponse](#bytebase-v1-BatchUpdateSavedQueryOrganizerResponse)
+ - [CreateSavedQueryRequest](#bytebase-v1-CreateSavedQueryRequest)
+ - [DeleteSavedQueryRequest](#bytebase-v1-DeleteSavedQueryRequest)
+ - [GetSavedQueryRequest](#bytebase-v1-GetSavedQueryRequest)
+ - [ListSavedQueriesRequest](#bytebase-v1-ListSavedQueriesRequest)
+ - [ListSavedQueriesResponse](#bytebase-v1-ListSavedQueriesResponse)
+ - [ListSavedQueryFoldersRequest](#bytebase-v1-ListSavedQueryFoldersRequest)
+ - [ListSavedQueryFoldersResponse](#bytebase-v1-ListSavedQueryFoldersResponse)
+ - [SavedQuery](#bytebase-v1-SavedQuery)
+ - [SavedQueryFolder](#bytebase-v1-SavedQueryFolder)
+ - [SavedQueryOrganizer](#bytebase-v1-SavedQueryOrganizer)
+ - [SearchSavedQueriesRequest](#bytebase-v1-SearchSavedQueriesRequest)
+ - [SearchSavedQueriesResponse](#bytebase-v1-SearchSavedQueriesResponse)
+ - [UpdateSavedQueryOrganizerRequest](#bytebase-v1-UpdateSavedQueryOrganizerRequest)
+ - [UpdateSavedQueryRequest](#bytebase-v1-UpdateSavedQueryRequest)
+
+ - [SavedQuery.Visibility](#bytebase-v1-SavedQuery-Visibility)
+ - [SavedQueryFolder.Category](#bytebase-v1-SavedQueryFolder-Category)
+
+ - [SavedQueryService](#bytebase-v1-SavedQueryService)
+
- [v1/service_account_service.proto](#v1_service_account_service-proto)
- [CreateServiceAccountRequest](#bytebase-v1-CreateServiceAccountRequest)
- [DeleteServiceAccountRequest](#bytebase-v1-DeleteServiceAccountRequest)
@@ -742,29 +765,6 @@
- [WorkloadIdentityService](#bytebase-v1-WorkloadIdentityService)
-- [v1/worksheet_service.proto](#v1_worksheet_service-proto)
- - [BatchUpdateWorksheetOrganizerRequest](#bytebase-v1-BatchUpdateWorksheetOrganizerRequest)
- - [BatchUpdateWorksheetOrganizerResponse](#bytebase-v1-BatchUpdateWorksheetOrganizerResponse)
- - [CreateWorksheetRequest](#bytebase-v1-CreateWorksheetRequest)
- - [DeleteWorksheetRequest](#bytebase-v1-DeleteWorksheetRequest)
- - [GetWorksheetRequest](#bytebase-v1-GetWorksheetRequest)
- - [ListWorksheetFoldersRequest](#bytebase-v1-ListWorksheetFoldersRequest)
- - [ListWorksheetFoldersResponse](#bytebase-v1-ListWorksheetFoldersResponse)
- - [ListWorksheetsRequest](#bytebase-v1-ListWorksheetsRequest)
- - [ListWorksheetsResponse](#bytebase-v1-ListWorksheetsResponse)
- - [SearchWorksheetsRequest](#bytebase-v1-SearchWorksheetsRequest)
- - [SearchWorksheetsResponse](#bytebase-v1-SearchWorksheetsResponse)
- - [UpdateWorksheetOrganizerRequest](#bytebase-v1-UpdateWorksheetOrganizerRequest)
- - [UpdateWorksheetRequest](#bytebase-v1-UpdateWorksheetRequest)
- - [Worksheet](#bytebase-v1-Worksheet)
- - [WorksheetFolder](#bytebase-v1-WorksheetFolder)
- - [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer)
-
- - [Worksheet.Visibility](#bytebase-v1-Worksheet-Visibility)
- - [WorksheetFolder.Category](#bytebase-v1-WorksheetFolder-Category)
-
- - [WorksheetService](#bytebase-v1-WorksheetService)
-
- [v1/workspace_service.proto](#v1_workspace_service-proto)
- [DeleteWorkspaceRequest](#bytebase-v1-DeleteWorkspaceRequest)
- [GetWorkspaceRequest](#bytebase-v1-GetWorkspaceRequest)
@@ -11016,6 +11016,355 @@ RoleService manages workspace roles and permissions.
+<a name="v1_saved_query_service-proto"></a>
+<p align="right"><a href="#top">Top</a></p>
+
+## v1/saved_query_service.proto
+
+
+
+<a name="bytebase-v1-BatchUpdateSavedQueryOrganizerRequest"></a>
+
+### BatchUpdateSavedQueryOrganizerRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent resource whose saved queries&#39; organizers are updated. Format: projects/{project} |
+| filter | [string](#string) | | To filter the batch update target. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter: - name: the saved query name in &#34;projects/{project}/savedQueries/{savedQuery}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator. - creator: the saved query creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator. - starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred saved queries, support &#34;==&#34; operator. - visibility: check Visibility enum in the SavedQuery message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator. - folder: the saved query organizer folder path, support exact &#34;==&#34; operator. |
+| organizer | [SavedQueryOrganizer](#bytebase-v1-SavedQueryOrganizer) | | The organizer fields to update. |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the saved query organizer. Only support update the following fields for now: - `starred` - `folders` |
+
+
+
+
+
+
+<a name="bytebase-v1-BatchUpdateSavedQueryOrganizerResponse"></a>
+
+### BatchUpdateSavedQueryOrganizerResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| saved_query_organizers | [SavedQueryOrganizer](#bytebase-v1-SavedQueryOrganizer) | repeated | |
+| updated_count | [int32](#int32) | | |
+
+
+
+
+
+
+<a name="bytebase-v1-CreateSavedQueryRequest"></a>
+
+### CreateSavedQueryRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent resource where this saved query will be created. Format: projects/{project} |
+| saved_query | [SavedQuery](#bytebase-v1-SavedQuery) | | The saved query to create. |
+
+
+
+
+
+
+<a name="bytebase-v1-DeleteSavedQueryRequest"></a>
+
+### DeleteSavedQueryRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the saved query to delete. Format: projects/{project}/savedQueries/{savedQuery} |
+
+
+
+
+
+
+<a name="bytebase-v1-GetSavedQueryRequest"></a>
+
+### GetSavedQueryRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the saved query to retrieve. Format: projects/{project}/savedQueries/{savedQuery} |
+
+
+
+
+
+
+<a name="bytebase-v1-ListSavedQueriesRequest"></a>
+
+### ListSavedQueriesRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent resource of the saved queries. Format: projects/{project} Use &#34;projects/-&#34; to list saved queries across all projects. |
+| filter | [string](#string) | | To filter the list result. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter: - creator: the saved query creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
+
+For example: creator == &#34;users/{email}&#34; creator != &#34;users/{email}&#34; |
+| page_size | [int32](#int32) | | The maximum number of saved queries to return. The service may return fewer than this value. If unspecified, at most 10 saved queries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `ListSavedQueries` call. Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListSavedQueries` must match the call that provided the page token. |
+
+
+
+
+
+
+<a name="bytebase-v1-ListSavedQueriesResponse"></a>
+
+### ListSavedQueriesResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| saved_queries | [SavedQuery](#bytebase-v1-SavedQuery) | repeated | The saved queries from the specified parent. |
+| next_page_token | [string](#string) | | A token to retrieve next page of saved queries. Pass this value in the page_token field in the subsequent call to `ListSavedQueries` method to retrieve the next page of saved queries. |
+
+
+
+
+
+
+<a name="bytebase-v1-ListSavedQueryFoldersRequest"></a>
+
+### ListSavedQueryFoldersRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent resource of the saved query folders. Format: projects/{project} |
+
+
+
+
+
+
+<a name="bytebase-v1-ListSavedQueryFoldersResponse"></a>
+
+### ListSavedQueryFoldersResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| folders | [SavedQueryFolder](#bytebase-v1-SavedQueryFolder) | repeated | The caller&#39;s saved query folders. |
+
+
+
+
+
+
+<a name="bytebase-v1-SavedQuery"></a>
+
+### SavedQuery
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| name | [string](#string) | | The name of the saved query resource, generated by the server. Canonical parent is project. Format: projects/{project}/savedQueries/{savedQuery} |
+| project | [string](#string) | | The project resource name. Format: projects/{project} |
+| database | [string](#string) | | The database resource name. Format: instances/{instance}/databases/{database} If the database parent doesn&#39;t exist, the database field is empty. |
+| title | [string](#string) | | The title of the saved query. |
+| creator | [string](#string) | | The creator of the SavedQuery. Format: users/{email} |
+| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The create time of the saved query. |
+| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last update time of the saved query. |
+| content | [bytes](#bytes) | | The content of the saved query. By default, it will be cut off in SearchSavedQueries() method. If it doesn&#39;t match the `content_size`, you can use GetSavedQuery() request to retrieve the full content. |
+| content_size | [int64](#int64) | | content_size is the full size of the content, may not match the size of the `content` field. |
+| visibility | [SavedQuery.Visibility](#bytebase-v1-SavedQuery-Visibility) | | |
+| starred | [bool](#bool) | | starred indicates whether the saved query is starred by the current authenticated user. |
+| folders | [string](#string) | repeated | |
+
+
+
+
+
+
+<a name="bytebase-v1-SavedQueryFolder"></a>
+
+### SavedQueryFolder
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| folders | [string](#string) | repeated | The folder path segments. |
+| category | [SavedQueryFolder.Category](#bytebase-v1-SavedQueryFolder-Category) | | The folder category. |
+
+
+
+
+
+
+<a name="bytebase-v1-SavedQueryOrganizer"></a>
+
+### SavedQueryOrganizer
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| saved_query | [string](#string) | | The name of the saved query. Format: projects/{project}/savedQueries/{savedQuery} |
+| starred | [bool](#bool) | | starred means if the saved query is starred. |
+| folders | [string](#string) | repeated | |
+
+
+
+
+
+
+<a name="bytebase-v1-SearchSavedQueriesRequest"></a>
+
+### SearchSavedQueriesRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| parent | [string](#string) | | The parent resource of the saved queries. Format: projects/{project} |
+| filter | [string](#string) | | To filter the search result. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter: - name: the saved query name in &#34;projects/{project}/savedQueries/{savedQuery}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator. - title: the saved query title, support &#34;contains&#34; operator. - creator: the saved query creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator. - starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred saved queries, support &#34;==&#34; operator. - visibility: check Visibility enum in the SavedQuery message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator. - folder: the saved query organizer folder path, support &#34;==&#34; operator.
+
+For example: creator == &#34;users/{email}&#34; title.contains(&#34;saved query title&#34;) creator != &#34;users/{email}&#34; starred == true starred == false visibility in [&#34;PRIVATE&#34;, &#34;PROJECT_READ&#34;, &#34;PROJECT_WRITE&#34;] visibility == &#34;PRIVATE&#34; folder == &#34;foo/bar&#34; |
+| page_size | [int32](#int32) | | The maximum number of saved queries to return. The service may return fewer than this value. If unspecified, at most 10 saved queries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
+| page_token | [string](#string) | | A page token, received from a previous `SearchSavedQueries` call. Provide this to retrieve the subsequent page. |
+
+
+
+
+
+
+<a name="bytebase-v1-SearchSavedQueriesResponse"></a>
+
+### SearchSavedQueriesResponse
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| saved_queries | [SavedQuery](#bytebase-v1-SavedQuery) | repeated | The saved queries that matched the search criteria. |
+| next_page_token | [string](#string) | | A token to retrieve next page of saved queries. Pass this value in the page_token field in the subsequent call to `SearchSavedQueries` method to retrieve the next page of saved queries. |
+
+
+
+
+
+
+<a name="bytebase-v1-UpdateSavedQueryOrganizerRequest"></a>
+
+### UpdateSavedQueryOrganizerRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| organizer | [SavedQueryOrganizer](#bytebase-v1-SavedQueryOrganizer) | | The organizer to update.
+
+The organizer&#39;s `saved_query` field is used to identify the saved query. Format: projects/{project}/savedQueries/{savedQuery} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the saved query organizer. Only support update the following fields for now: - `starred` |
+| allow_missing | [bool](#bool) | | If set to true, and the saved query organizer is not found, a new saved query organizer will be created. In this situation, `update_mask` is ignored. |
+
+
+
+
+
+
+<a name="bytebase-v1-UpdateSavedQueryRequest"></a>
+
+### UpdateSavedQueryRequest
+
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| saved_query | [SavedQuery](#bytebase-v1-SavedQuery) | | The saved query to update.
+
+The saved query&#39;s `name` field is used to identify the saved query to update. Format: projects/{project}/savedQueries/{savedQuery} |
+| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the saved query. (e.g., `title`, `statement`; *not* `saved_query.title` or `saved_query.statement`) Only support update the following fields for now: - `title` - `statement` - `starred` - `visibility` |
+
+
+
+
+
+
+
+
+<a name="bytebase-v1-SavedQuery-Visibility"></a>
+
+### SavedQuery.Visibility
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| VISIBILITY_UNSPECIFIED | 0 | |
+| PROJECT_READ | 1 | Read access in project scope, saved query OWNER/DBA and project OWNER can read/write, other project members can read. |
+| PROJECT_WRITE | 2 | Write access in project scope, saved query OWNER/DBA and all members in the project can write the saved query. |
+| PRIVATE | 3 | Private, only saved query OWNER can read/write. |
+
+
+
+<a name="bytebase-v1-SavedQueryFolder-Category"></a>
+
+### SavedQueryFolder.Category
+
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| CATEGORY_UNSPECIFIED | 0 | |
+| MINE | 1 | |
+| SHARED | 2 | |
+
+
+
+
+
+
+
+<a name="bytebase-v1-SavedQueryService"></a>
+
+### SavedQueryService
+SavedQueryService manages saved queries for SQL Editor query development.
+Permission IDs still use the legacy `bb.worksheets.*` names; they are
+renamed together with the access-model redesign and its role migration.
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| CreateSavedQuery | [CreateSavedQueryRequest](#bytebase-v1-CreateSavedQueryRequest) | [SavedQuery](#bytebase-v1-SavedQuery) | Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries. Permissions required: None (authenticated users only) |
+| GetSavedQuery | [GetSavedQueryRequest](#bytebase-v1-GetSavedQueryRequest) | [SavedQuery](#bytebase-v1-SavedQuery) | Get a saved query by name. The users can access this method if, - they are the creator of the saved query; - they have bb.worksheets.get permission on the workspace; - the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries) |
+| ListSavedQueries | [ListSavedQueriesRequest](#bytebase-v1-ListSavedQueriesRequest) | [ListSavedQueriesResponse](#bytebase-v1-ListSavedQueriesResponse) | List saved queries. This is used for listing saved queries in a project, or across all projects by using `projects/-`. Permissions required: bb.worksheets.list |
+| ListSavedQueryFolders | [ListSavedQueryFoldersRequest](#bytebase-v1-ListSavedQueryFoldersRequest) | [ListSavedQueryFoldersResponse](#bytebase-v1-ListSavedQueryFoldersResponse) | List the caller&#39;s saved query folders. Only folders stored in the caller&#39;s saved query organizer are returned. |
+| SearchSavedQueries | [SearchSavedQueriesRequest](#bytebase-v1-SearchSavedQueriesRequest) | [SearchSavedQueriesResponse](#bytebase-v1-SearchSavedQueriesResponse) | Search for saved queries. This is used for finding my saved queries or saved queries shared by other people. The saved query accessibility is the same as GetSavedQuery(). Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries) |
+| UpdateSavedQuery | [UpdateSavedQueryRequest](#bytebase-v1-UpdateSavedQueryRequest) | [SavedQuery](#bytebase-v1-SavedQuery) | Update a saved query. The users can access this method if, - they are the creator of the saved query; - they have bb.worksheets.manage permission on the workspace; - the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries) |
+| UpdateSavedQueryOrganizer | [UpdateSavedQueryOrganizerRequest](#bytebase-v1-UpdateSavedQueryOrganizerRequest) | [SavedQueryOrganizer](#bytebase-v1-SavedQueryOrganizer) | Update the organizer of a saved query. The access is the same as UpdateSavedQuery method. Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries) |
+| BatchUpdateSavedQueryOrganizer | [BatchUpdateSavedQueryOrganizerRequest](#bytebase-v1-BatchUpdateSavedQueryOrganizerRequest) | [BatchUpdateSavedQueryOrganizerResponse](#bytebase-v1-BatchUpdateSavedQueryOrganizerResponse) | Batch update the organizers of saved queries. The access is the same as UpdateSavedQuery method. Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries) |
+| DeleteSavedQuery | [DeleteSavedQueryRequest](#bytebase-v1-DeleteSavedQueryRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Delete a saved query. The access is the same as UpdateSavedQuery method. Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries) |
+
+
+
+
+
<a name="v1_service_account_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
@@ -11982,353 +12331,6 @@ WorkloadIdentityService manages workload identities for external CI/CD integrati
-<a name="v1_worksheet_service-proto"></a>
-<p align="right"><a href="#top">Top</a></p>
-
-## v1/worksheet_service.proto
-
-
-
-<a name="bytebase-v1-BatchUpdateWorksheetOrganizerRequest"></a>
-
-### BatchUpdateWorksheetOrganizerRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource whose worksheets&#39; organizers are updated. Format: projects/{project} |
-| filter | [string](#string) | | To filter the batch update target. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter: - name: the worksheet name in &#34;projects/{project}/worksheets/{worksheet}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator. - creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator. - starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred sheets, support &#34;==&#34; operator. - visibility: check Visibility enum in the Worksheet message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator. - folder: the worksheet organizer folder path, support exact &#34;==&#34; operator. |
-| organizer | [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer) | | The organizer fields to update. |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the worksheet organizer. Only support update the following fields for now: - `starred` - `folders` |
-
-
-
-
-
-
-<a name="bytebase-v1-BatchUpdateWorksheetOrganizerResponse"></a>
-
-### BatchUpdateWorksheetOrganizerResponse
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| worksheet_organizers | [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer) | repeated | |
-| updated_count | [int32](#int32) | | |
-
-
-
-
-
-
-<a name="bytebase-v1-CreateWorksheetRequest"></a>
-
-### CreateWorksheetRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource where this worksheet will be created. Format: projects/{project} |
-| worksheet | [Worksheet](#bytebase-v1-Worksheet) | | The worksheet to create. |
-
-
-
-
-
-
-<a name="bytebase-v1-DeleteWorksheetRequest"></a>
-
-### DeleteWorksheetRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the worksheet to delete. Format: projects/{project}/worksheets/{worksheet} |
-
-
-
-
-
-
-<a name="bytebase-v1-GetWorksheetRequest"></a>
-
-### GetWorksheetRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the worksheet to retrieve. Format: projects/{project}/worksheets/{worksheet} |
-
-
-
-
-
-
-<a name="bytebase-v1-ListWorksheetFoldersRequest"></a>
-
-### ListWorksheetFoldersRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource of the worksheet folders. Format: projects/{project} |
-
-
-
-
-
-
-<a name="bytebase-v1-ListWorksheetFoldersResponse"></a>
-
-### ListWorksheetFoldersResponse
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| folders | [WorksheetFolder](#bytebase-v1-WorksheetFolder) | repeated | The caller&#39;s worksheet folders. |
-
-
-
-
-
-
-<a name="bytebase-v1-ListWorksheetsRequest"></a>
-
-### ListWorksheetsRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource of the worksheets. Format: projects/{project} Use &#34;projects/-&#34; to list worksheets across all projects. |
-| filter | [string](#string) | | To filter the list result. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter: - creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
-
-For example: creator == &#34;users/{email}&#34; creator != &#34;users/{email}&#34; |
-| page_size | [int32](#int32) | | The maximum number of worksheets to return. The service may return fewer than this value. If unspecified, at most 10 worksheets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `ListWorksheets` call. Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListWorksheets` must match the call that provided the page token. |
-
-
-
-
-
-
-<a name="bytebase-v1-ListWorksheetsResponse"></a>
-
-### ListWorksheetsResponse
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| worksheets | [Worksheet](#bytebase-v1-Worksheet) | repeated | The worksheets from the specified parent. |
-| next_page_token | [string](#string) | | A token to retrieve next page of worksheets. Pass this value in the page_token field in the subsequent call to `ListWorksheets` method to retrieve the next page of worksheets. |
-
-
-
-
-
-
-<a name="bytebase-v1-SearchWorksheetsRequest"></a>
-
-### SearchWorksheetsRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| parent | [string](#string) | | The parent resource of the worksheets. Format: projects/{project} |
-| filter | [string](#string) | | To filter the search result. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter: - name: the worksheet name in &#34;projects/{project}/worksheets/{worksheet}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator. - title: the worksheet title, support &#34;contains&#34; operator. - creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator. - starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred sheets, support &#34;==&#34; operator. - visibility: check Visibility enum in the Worksheet message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator. - folder: the worksheet organizer folder path, support &#34;==&#34; operator.
-
-For example: creator == &#34;users/{email}&#34; title.contains(&#34;worksheet title&#34;) creator != &#34;users/{email}&#34; starred == true starred == false visibility in [&#34;PRIVATE&#34;, &#34;PROJECT_READ&#34;, &#34;PROJECT_WRITE&#34;] visibility == &#34;PRIVATE&#34; folder == &#34;foo/bar&#34; |
-| page_size | [int32](#int32) | | The maximum number of worksheets to return. The service may return fewer than this value. If unspecified, at most 10 worksheets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
-| page_token | [string](#string) | | A page token, received from a previous `SearchWorksheets` call. Provide this to retrieve the subsequent page. |
-
-
-
-
-
-
-<a name="bytebase-v1-SearchWorksheetsResponse"></a>
-
-### SearchWorksheetsResponse
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| worksheets | [Worksheet](#bytebase-v1-Worksheet) | repeated | The worksheets that matched the search criteria. |
-| next_page_token | [string](#string) | | A token to retrieve next page of worksheets. Pass this value in the page_token field in the subsequent call to `SearchWorksheets` method to retrieve the next page of worksheets. |
-
-
-
-
-
-
-<a name="bytebase-v1-UpdateWorksheetOrganizerRequest"></a>
-
-### UpdateWorksheetOrganizerRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| organizer | [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer) | | The organizer to update.
-
-The organizer&#39;s `worksheet` field is used to identify the worksheet. Format: projects/{project}/worksheets/{worksheet} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the worksheet organizer. Only support update the following fields for now: - `starred` |
-| allow_missing | [bool](#bool) | | If set to true, and the worksheet organizer is not found, a new worksheet organizer will be created. In this situation, `update_mask` is ignored. |
-
-
-
-
-
-
-<a name="bytebase-v1-UpdateWorksheetRequest"></a>
-
-### UpdateWorksheetRequest
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| worksheet | [Worksheet](#bytebase-v1-Worksheet) | | The worksheet to update.
-
-The worksheet&#39;s `name` field is used to identify the worksheet to update. Format: projects/{project}/worksheets/{worksheet} |
-| update_mask | [google.protobuf.FieldMask](#google-protobuf-FieldMask) | | The list of fields to be updated. Fields are specified relative to the worksheet. (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`) Only support update the following fields for now: - `title` - `statement` - `starred` - `visibility` |
-
-
-
-
-
-
-<a name="bytebase-v1-Worksheet"></a>
-
-### Worksheet
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| name | [string](#string) | | The name of the worksheet resource, generated by the server. Canonical parent is project. Format: projects/{project}/worksheets/{worksheet} |
-| project | [string](#string) | | The project resource name. Format: projects/{project} |
-| database | [string](#string) | | The database resource name. Format: instances/{instance}/databases/{database} If the database parent doesn&#39;t exist, the database field is empty. |
-| title | [string](#string) | | The title of the worksheet. |
-| creator | [string](#string) | | The creator of the Worksheet. Format: users/{email} |
-| create_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The create time of the worksheet. |
-| update_time | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | The last update time of the worksheet. |
-| content | [bytes](#bytes) | | The content of the worksheet. By default, it will be cut off in SearchWorksheet() method. If it doesn&#39;t match the `content_size`, you can use GetWorksheet() request to retrieve the full content. |
-| 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 | |
-
-
-
-
-
-
-<a name="bytebase-v1-WorksheetFolder"></a>
-
-### WorksheetFolder
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| folders | [string](#string) | repeated | The folder path segments. |
-| category | [WorksheetFolder.Category](#bytebase-v1-WorksheetFolder-Category) | | The folder category. |
-
-
-
-
-
-
-<a name="bytebase-v1-WorksheetOrganizer"></a>
-
-### WorksheetOrganizer
-
-
-
-| Field | Type | Label | Description |
-| ----- | ---- | ----- | ----------- |
-| worksheet | [string](#string) | | The name of the worksheet. Format: projects/{project}/worksheets/{worksheet} |
-| starred | [bool](#bool) | | starred means if the worksheet is starred. |
-| folders | [string](#string) | repeated | |
-
-
-
-
-
-
-
-
-<a name="bytebase-v1-Worksheet-Visibility"></a>
-
-### Worksheet.Visibility
-
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| VISIBILITY_UNSPECIFIED | 0 | |
-| PROJECT_READ | 1 | Read access in project scope, worksheet OWNER/DBA and project OWNER can read/write, other project members can read. |
-| PROJECT_WRITE | 2 | Write access in project scope, worksheet OWNER/DBA and all members in the project can write the worksheet. |
-| PRIVATE | 3 | Private, only worksheet OWNER can read/write. |
-
-
-
-<a name="bytebase-v1-WorksheetFolder-Category"></a>
-
-### WorksheetFolder.Category
-
-
-| Name | Number | Description |
-| ---- | ------ | ----------- |
-| CATEGORY_UNSPECIFIED | 0 | |
-| MINE | 1 | |
-| SHARED | 2 | |
-
-
-
-
-
-
-
-<a name="bytebase-v1-WorksheetService"></a>
-
-### WorksheetService
-WorksheetService manages SQL worksheets for query development.
-
-| Method Name | Request Type | Response Type | Description |
-| ----------- | ------------ | ------------- | ------------|
-| CreateWorksheet | [CreateWorksheetRequest](#bytebase-v1-CreateWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets. Permissions required: None (authenticated users only) |
-| GetWorksheet | [GetWorksheetRequest](#bytebase-v1-GetWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Get a worksheet by name. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.get permission on the workspace; - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |
-| ListWorksheets | [ListWorksheetsRequest](#bytebase-v1-ListWorksheetsRequest) | [ListWorksheetsResponse](#bytebase-v1-ListWorksheetsResponse) | List worksheets. This is used for listing worksheets in a project, or across all projects by using `projects/-`. Permissions required: bb.worksheets.list |
-| ListWorksheetFolders | [ListWorksheetFoldersRequest](#bytebase-v1-ListWorksheetFoldersRequest) | [ListWorksheetFoldersResponse](#bytebase-v1-ListWorksheetFoldersResponse) | List the caller&#39;s worksheet folders. Only folders stored in the caller&#39;s worksheet organizer are returned. |
-| SearchWorksheets | [SearchWorksheetsRequest](#bytebase-v1-SearchWorksheetsRequest) | [SearchWorksheetsResponse](#bytebase-v1-SearchWorksheetsResponse) | Search for worksheets. This is used for finding my worksheets or worksheets shared by other people. The sheet accessibility is the same as GetWorksheet(). Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |
-| UpdateWorksheet | [UpdateWorksheetRequest](#bytebase-v1-UpdateWorksheetRequest) | [Worksheet](#bytebase-v1-Worksheet) | Update a worksheet. The users can access this method if, - they are the creator of the worksheet; - they have bb.worksheets.manage permission on the workspace; - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project. Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets) |
-| UpdateWorksheetOrganizer | [UpdateWorksheetOrganizerRequest](#bytebase-v1-UpdateWorksheetOrganizerRequest) | [WorksheetOrganizer](#bytebase-v1-WorksheetOrganizer) | Update the organizer of a worksheet. The access is the same as UpdateWorksheet method. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |
-| BatchUpdateWorksheetOrganizer | [BatchUpdateWorksheetOrganizerRequest](#bytebase-v1-BatchUpdateWorksheetOrganizerRequest) | [BatchUpdateWorksheetOrganizerResponse](#bytebase-v1-BatchUpdateWorksheetOrganizerResponse) | Batch update the organizers of worksheets. The access is the same as UpdateWorksheet method. Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets) |
-| DeleteWorksheet | [DeleteWorksheetRequest](#bytebase-v1-DeleteWorksheetRequest) | [.google.protobuf.Empty](#google-protobuf-Empty) | Delete a worksheet. The access is the same as UpdateWorksheet method. Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets) |
-
-
-
-
-
<a name="v1_workspace_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index 8f6b05051d..f02ae4fa01 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -2748,6 +2748,93 @@
</li>
+ <li>
+ <a href="#v1%2fsaved_query_service.proto">v1/saved_query_service.proto</a>
+ <ul>
+
+ <li>
+ <a href="#bytebase.v1.BatchUpdateSavedQueryOrganizerRequest"><span class="badge">M</span>BatchUpdateSavedQueryOrganizerRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.BatchUpdateSavedQueryOrganizerResponse"><span class="badge">M</span>BatchUpdateSavedQueryOrganizerResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.CreateSavedQueryRequest"><span class="badge">M</span>CreateSavedQueryRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.DeleteSavedQueryRequest"><span class="badge">M</span>DeleteSavedQueryRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.GetSavedQueryRequest"><span class="badge">M</span>GetSavedQueryRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListSavedQueriesRequest"><span class="badge">M</span>ListSavedQueriesRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListSavedQueriesResponse"><span class="badge">M</span>ListSavedQueriesResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListSavedQueryFoldersRequest"><span class="badge">M</span>ListSavedQueryFoldersRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.ListSavedQueryFoldersResponse"><span class="badge">M</span>ListSavedQueryFoldersResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SavedQuery"><span class="badge">M</span>SavedQuery</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SavedQueryFolder"><span class="badge">M</span>SavedQueryFolder</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SavedQueryOrganizer"><span class="badge">M</span>SavedQueryOrganizer</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SearchSavedQueriesRequest"><span class="badge">M</span>SearchSavedQueriesRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SearchSavedQueriesResponse"><span class="badge">M</span>SearchSavedQueriesResponse</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdateSavedQueryOrganizerRequest"><span class="badge">M</span>UpdateSavedQueryOrganizerRequest</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.UpdateSavedQueryRequest"><span class="badge">M</span>UpdateSavedQueryRequest</a>
+ </li>
+
+
+ <li>
+ <a href="#bytebase.v1.SavedQuery.Visibility"><span class="badge">E</span>SavedQuery.Visibility</a>
+ </li>
+
+ <li>
+ <a href="#bytebase.v1.SavedQueryFolder.Category"><span class="badge">E</span>SavedQueryFolder.Category</a>
+ </li>
+
+
+
+ <li>
+ <a href="#bytebase.v1.SavedQueryService"><span class="badge">S</span>SavedQueryService</a>
+ </li>
+
+ </ul>
+ </li>
+
+
<li>
<a href="#v1%2fservice_account_service.proto">v1/service_account_service.proto</a>
<ul>
@@ -3000,93 +3087,6 @@
</li>
- <li>
- <a href="#v1%2fworksheet_service.proto">v1/worksheet_service.proto</a>
- <ul>
-
- <li>
- <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerRequest"><span class="badge">M</span>BatchUpdateWorksheetOrganizerRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.BatchUpdateWorksheetOrganizerResponse"><span class="badge">M</span>BatchUpdateWorksheetOrganizerResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.CreateWorksheetRequest"><span class="badge">M</span>CreateWorksheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.DeleteWorksheetRequest"><span class="badge">M</span>DeleteWorksheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.GetWorksheetRequest"><span class="badge">M</span>GetWorksheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ListWorksheetFoldersRequest"><span class="badge">M</span>ListWorksheetFoldersRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ListWorksheetFoldersResponse"><span class="badge">M</span>ListWorksheetFoldersResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ListWorksheetsRequest"><span class="badge">M</span>ListWorksheetsRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.ListWorksheetsResponse"><span class="badge">M</span>ListWorksheetsResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.SearchWorksheetsRequest"><span class="badge">M</span>SearchWorksheetsRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.SearchWorksheetsResponse"><span class="badge">M</span>SearchWorksheetsResponse</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.UpdateWorksheetOrganizerRequest"><span class="badge">M</span>UpdateWorksheetOrganizerRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.UpdateWorksheetRequest"><span class="badge">M</span>UpdateWorksheetRequest</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.Worksheet"><span class="badge">M</span>Worksheet</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.WorksheetFolder"><span class="badge">M</span>WorksheetFolder</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.WorksheetOrganizer"><span class="badge">M</span>WorksheetOrganizer</a>
- </li>
-
-
- <li>
- <a href="#bytebase.v1.Worksheet.Visibility"><span class="badge">E</span>Worksheet.Visibility</a>
- </li>
-
- <li>
- <a href="#bytebase.v1.WorksheetFolder.Category"><span class="badge">E</span>WorksheetFolder.Category</a>
- </li>
-
-
-
- <li>
- <a href="#bytebase.v1.WorksheetService"><span class="badge">S</span>WorksheetService</a>
- </li>
-
- </ul>
- </li>
-
-
<li>
<a href="#v1%2fworkspace_service.proto">v1/workspace_service.proto</a>
<ul>
@@ -31506,13 +31506,13 @@ Permissions required: bb.roles.delete</p></td>
<div class="file-heading">
- <h2 id="v1/service_account_service.proto">v1/service_account_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/saved_query_service.proto">v1/saved_query_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.CreateServiceAccountRequest">CreateServiceAccountRequest</h3>
- <p>Request message for creating a service account.</p>
+ <h3 id="bytebase.v1.BatchUpdateSavedQueryOrganizerRequest">BatchUpdateSavedQueryOrganizerRequest</h3>
+ <p></p>
<table class="field-table">
@@ -31525,24 +31525,41 @@ Permissions required: bb.roles.delete</p></td>
<td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource where this service account will be created.
-Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td>
+ <td><p>The parent resource whose saved queries&#39; organizers are updated.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>service_account_id</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The ID to use for the service account, which will become the final component
-of the service account&#39;s email in the format: {service_account_id}@service.bytebase.com
-or {service_account_id}@{project-id}.service.bytebase.com </p></td>
+ <td><p>To filter the batch update target.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- name: the saved query name in &#34;projects/{project}/savedQueries/{savedQuery}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator.
+- creator: the saved query creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
+- starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred saved queries, support &#34;==&#34; operator.
+- visibility: check Visibility enum in the SavedQuery message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator.
+- folder: the saved query organizer folder path, support exact &#34;==&#34; operator. </p></td>
</tr>
<tr>
- <td>service_account</td>
- <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
+ <td>organizer</td>
+ <td><a href="#bytebase.v1.SavedQueryOrganizer">SavedQueryOrganizer</a></td>
<td></td>
- <td><p>The service account to create. </p></td>
+ <td><p>The organizer fields to update. </p></td>
+ </tr>
+
+ <tr>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to be updated.
+Fields are specified relative to the saved query organizer.
+Only support update the following fields for now:
+- `starred`
+- `folders` </p></td>
</tr>
</tbody>
@@ -31552,8 +31569,71 @@ or {service_account_id}@{project-id}.service.bytebase.com </p></td>
- <h3 id="bytebase.v1.DeleteServiceAccountRequest">DeleteServiceAccountRequest</h3>
- <p>Request message for deleting a service account.</p>
+ <h3 id="bytebase.v1.BatchUpdateSavedQueryOrganizerResponse">BatchUpdateSavedQueryOrganizerResponse</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>saved_query_organizers</td>
+ <td><a href="#bytebase.v1.SavedQueryOrganizer">SavedQueryOrganizer</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>updated_count</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.CreateSavedQueryRequest">CreateSavedQueryRequest</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>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent resource where this saved query will be created.
+Format: projects/{project} </p></td>
+ </tr>
+
+ <tr>
+ <td>saved_query</td>
+ <td><a href="#bytebase.v1.SavedQuery">SavedQuery</a></td>
+ <td></td>
+ <td><p>The saved query to create. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.DeleteSavedQueryRequest">DeleteSavedQueryRequest</h3>
+ <p></p>
<table class="field-table">
@@ -31566,8 +31646,8 @@ or {service_account_id}@{project-id}.service.bytebase.com </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the service account to delete.
-Format: serviceAccounts/{email} </p></td>
+ <td><p>The name of the saved query to delete.
+Format: projects/{project}/savedQueries/{savedQuery} </p></td>
</tr>
</tbody>
@@ -31577,8 +31657,8 @@ Format: serviceAccounts/{email} </p></td>
- <h3 id="bytebase.v1.GetServiceAccountRequest">GetServiceAccountRequest</h3>
- <p>Request message for getting a service account.</p>
+ <h3 id="bytebase.v1.GetSavedQueryRequest">GetSavedQueryRequest</h3>
+ <p></p>
<table class="field-table">
@@ -31591,8 +31671,8 @@ Format: serviceAccounts/{email} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the service account to retrieve.
-Format: serviceAccounts/{email} </p></td>
+ <td><p>The name of the saved query to retrieve.
+Format: projects/{project}/savedQueries/{savedQuery} </p></td>
</tr>
</tbody>
@@ -31602,8 +31682,8 @@ Format: serviceAccounts/{email} </p></td>
- <h3 id="bytebase.v1.ListServiceAccountsRequest">ListServiceAccountsRequest</h3>
- <p>Request message for listing service accounts.</p>
+ <h3 id="bytebase.v1.ListSavedQueriesRequest">ListSavedQueriesRequest</h3>
+ <p></p>
<table class="field-table">
@@ -31616,17 +31696,33 @@ Format: serviceAccounts/{email} </p></td>
<td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource.
-Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td>
+ <td><p>The parent resource of the saved queries.
+Format: projects/{project}
+Use &#34;projects/-&#34; to list saved queries across all projects. </p></td>
+ </tr>
+
+ <tr>
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>To filter the list result.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- creator: the saved query creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
+
+For example:
+creator == &#34;users/{email}&#34;
+creator != &#34;users/{email}&#34; </p></td>
</tr>
<tr>
<td>page_size</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The maximum number of service accounts to return. The service may return fewer than
+ <td><p>The maximum number of saved queries to return. The service may return fewer than
this value.
-If unspecified, at most 10 service accounts will be returned.
+If unspecified, at most 10 saved queries will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
@@ -31634,38 +31730,44 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
<td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListServiceAccounts` call.
+ <td><p>A page token, received from a previous `ListSavedQueries` call.
Provide this to retrieve the subsequent page.
-When paginating, all other parameters provided to `ListServiceAccounts` must match
+When paginating, all other parameters provided to `ListSavedQueries` must match
the call that provided the page token. </p></td>
</tr>
- <tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Show deleted service accounts if specified. </p></td>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListSavedQueriesResponse">ListSavedQueriesResponse</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>saved_queries</td>
+ <td><a href="#bytebase.v1.SavedQuery">SavedQuery</a></td>
+ <td>repeated</td>
+ <td><p>The saved queries from the specified parent. </p></td>
</tr>
<tr>
- <td>filter</td>
+ <td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Filter is used to filter service accounts returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- name: the service account name, support &#34;==&#34; and &#34;.contains()&#34; operator.
-- email: the service account email, support &#34;==&#34; and &#34;.contains()&#34; operator.
-- state: check State enum for values, support &#34;==&#34; operator.
-
-For example:
-name == &#34;ed&#34;
-name.contains(&#34;ed&#34;)
-state == &#34;DELETED&#34;
-email == &#34;[email protected]&#34;
-email.contains(&#34;ed&#34;) </p></td>
+ <td><p>A token to retrieve next page of saved queries.
+Pass this value in the page_token field in the subsequent call to
+`ListSavedQueries` method to retrieve the next page of saved queries. </p></td>
</tr>
</tbody>
@@ -31675,8 +31777,8 @@ email.contains(&#34;ed&#34;) </p></td>
- <h3 id="bytebase.v1.ListServiceAccountsResponse">ListServiceAccountsResponse</h3>
- <p>Response message for listing service accounts.</p>
+ <h3 id="bytebase.v1.ListSavedQueryFoldersRequest">ListSavedQueryFoldersRequest</h3>
+ <p></p>
<table class="field-table">
@@ -31686,18 +31788,35 @@ email.contains(&#34;ed&#34;) </p></td>
<tbody>
<tr>
- <td>service_accounts</td>
- <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
- <td>repeated</td>
- <td><p>The service accounts from the specified request. </p></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The parent resource of the saved query folders.
+Format: projects/{project} </p></td>
</tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.ListSavedQueryFoldersResponse">ListSavedQueryFoldersResponse</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>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td>folders</td>
+ <td><a href="#bytebase.v1.SavedQueryFolder">SavedQueryFolder</a></td>
+ <td>repeated</td>
+ <td><p>The caller&#39;s saved query folders. </p></td>
</tr>
</tbody>
@@ -31707,8 +31826,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.ServiceAccount">ServiceAccount</h3>
- <p>ServiceAccount represents an API integration account.</p>
+ <h3 id="bytebase.v1.SavedQuery">SavedQuery</h3>
+ <p></p>
<table class="field-table">
@@ -31721,45 +31840,92 @@ If this field is omitted, there are no subsequent pages. </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the service account.
-Format: serviceAccounts/{email} </p></td>
+ <td><p>The name of the saved query resource, generated by the server.
+Canonical parent is project.
+Format: projects/{project}/savedQueries/{savedQuery} </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
+ <td>project</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The state of the service account. </p></td>
+ <td><p>The project resource name.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>email</td>
+ <td>database</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The email of the service account.
-For workspace-level: {name}@service.bytebase.com
-For project-level: {name}@{project-id}.service.bytebase.com </p></td>
+ <td><p>The database resource name.
+Format: instances/{instance}/databases/{database}
+If the database parent doesn&#39;t exist, the database field is empty. </p></td>
</tr>
<tr>
<td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The display title of the service account. </p></td>
+ <td><p>The title of the saved query. </p></td>
</tr>
<tr>
- <td>service_key</td>
+ <td>creator</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The service key for authentication. Only returned on creation or key rotation. </p></td>
+ <td><p>The creator of the SavedQuery.
+Format: users/{email} </p></td>
</tr>
<tr>
<td>create_time</td>
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The timestamp when the service account was created. </p></td>
+ <td><p>The create time of the saved query. </p></td>
+ </tr>
+
+ <tr>
+ <td>update_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p>The last update time of the saved query. </p></td>
+ </tr>
+
+ <tr>
+ <td>content</td>
+ <td><a href="#bytes">bytes</a></td>
+ <td></td>
+ <td><p>The content of the saved query.
+By default, it will be cut off in SearchSavedQueries() method. If it doesn&#39;t match the `content_size`, you can
+use GetSavedQuery() request to retrieve the full content. </p></td>
+ </tr>
+
+ <tr>
+ <td>content_size</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>content_size is the full size of the content, may not match the size of the `content` field. </p></td>
+ </tr>
+
+ <tr>
+ <td>visibility</td>
+ <td><a href="#bytebase.v1.SavedQuery.Visibility">SavedQuery.Visibility</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>starred</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>starred indicates whether the saved query 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>
@@ -31769,8 +31935,8 @@ For project-level: {name}@{project-id}.service.bytebase.com </p></td>
- <h3 id="bytebase.v1.UndeleteServiceAccountRequest">UndeleteServiceAccountRequest</h3>
- <p>Request message for restoring a deleted service account.</p>
+ <h3 id="bytebase.v1.SavedQueryFolder">SavedQueryFolder</h3>
+ <p></p>
<table class="field-table">
@@ -31780,11 +31946,17 @@ For project-level: {name}@{project-id}.service.bytebase.com </p></td>
<tbody>
<tr>
- <td>name</td>
+ <td>folders</td>
<td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>The folder path segments. </p></td>
+ </tr>
+
+ <tr>
+ <td>category</td>
+ <td><a href="#bytebase.v1.SavedQueryFolder.Category">SavedQueryFolder.Category</a></td>
<td></td>
- <td><p>The name of the deleted service account.
-Format: serviceAccounts/{email} </p></td>
+ <td><p>The folder category. </p></td>
</tr>
</tbody>
@@ -31794,8 +31966,8 @@ Format: serviceAccounts/{email} </p></td>
- <h3 id="bytebase.v1.UpdateServiceAccountRequest">UpdateServiceAccountRequest</h3>
- <p>Request message for updating a service account.</p>
+ <h3 id="bytebase.v1.SavedQueryOrganizer">SavedQueryOrganizer</h3>
+ <p></p>
<table class="field-table">
@@ -31805,21 +31977,25 @@ Format: serviceAccounts/{email} </p></td>
<tbody>
<tr>
- <td>service_account</td>
- <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
+ <td>saved_query</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The service account to update.
-
-The service account&#39;s `name` field is used to identify the service account to update.
-Format: serviceAccounts/{email} </p></td>
+ <td><p>The name of the saved query.
+Format: projects/{project}/savedQueries/{savedQuery} </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>starred</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The list of fields to update.
-Supported fields: title, service_key (triggers key rotation) </p></td>
+ <td><p>starred means if the saved query 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>
@@ -31829,181 +32005,13 @@ Supported fields: title, service_key (triggers key rotation) </p></td>
-
-
-
-
-
-
- <h3 id="bytebase.v1.ServiceAccountService">ServiceAccountService</h3>
- <p>ServiceAccountService manages service accounts for API integrations.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>CreateServiceAccount</td>
- <td><a href="#bytebase.v1.CreateServiceAccountRequest">CreateServiceAccountRequest</a></td>
- <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
- <td><p>Creates a new service account.
-For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.create on workspace.
-For project-level: parent is projects/{project}, permission bb.serviceAccounts.create on project.</p></td>
- </tr>
-
- <tr>
- <td>GetServiceAccount</td>
- <td><a href="#bytebase.v1.GetServiceAccountRequest">GetServiceAccountRequest</a></td>
- <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
- <td><p>Gets a service account by name.
-Permissions required: bb.serviceAccounts.get</p></td>
- </tr>
-
- <tr>
- <td>ListServiceAccounts</td>
- <td><a href="#bytebase.v1.ListServiceAccountsRequest">ListServiceAccountsRequest</a></td>
- <td><a href="#bytebase.v1.ListServiceAccountsResponse">ListServiceAccountsResponse</a></td>
- <td><p>Lists service accounts.
-For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.list on workspace.
-For project-level: parent is projects/{project}, permission bb.serviceAccounts.list on project.</p></td>
- </tr>
-
- <tr>
- <td>UpdateServiceAccount</td>
- <td><a href="#bytebase.v1.UpdateServiceAccountRequest">UpdateServiceAccountRequest</a></td>
- <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
- <td><p>Updates a service account.
-Permissions required: bb.serviceAccounts.update</p></td>
- </tr>
-
- <tr>
- <td>DeleteServiceAccount</td>
- <td><a href="#bytebase.v1.DeleteServiceAccountRequest">DeleteServiceAccountRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a service account.
-Permissions required: bb.serviceAccounts.delete</p></td>
- </tr>
-
- <tr>
- <td>UndeleteServiceAccount</td>
- <td><a href="#bytebase.v1.UndeleteServiceAccountRequest">UndeleteServiceAccountRequest</a></td>
- <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
- <td><p>Restores a deleted service account.
-Permissions required: bb.serviceAccounts.undelete</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.SearchSavedQueriesRequest">SearchSavedQueriesRequest</h3>
+ <p></p>
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
- </thead>
- <tbody>
-
-
-
- <tr>
- <td>CreateServiceAccount</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/serviceAccounts</td>
- <td>service_account</td>
- </tr>
-
- <tr>
- <td>CreateServiceAccount</td>
- <td>POST</td>
- <td>/v1/{parent=workspaces/*}/serviceAccounts</td>
- <td>service_account</td>
- </tr>
-
-
-
-
- <tr>
- <td>GetServiceAccount</td>
- <td>GET</td>
- <td>/v1/{name=serviceAccounts/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>ListServiceAccounts</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/serviceAccounts</td>
- <td></td>
- </tr>
-
- <tr>
- <td>ListServiceAccounts</td>
- <td>GET</td>
- <td>/v1/{parent=workspaces/*}/serviceAccounts</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UpdateServiceAccount</td>
- <td>PATCH</td>
- <td>/v1/{service_account.name=serviceAccounts/*}</td>
- <td>service_account</td>
- </tr>
-
-
-
-
- <tr>
- <td>DeleteServiceAccount</td>
- <td>DELETE</td>
- <td>/v1/{name=serviceAccounts/*}</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UndeleteServiceAccount</td>
- <td>POST</td>
- <td>/v1/{name=serviceAccounts/*}:undelete</td>
- <td>*</td>
- </tr>
-
-
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/sheet_service.proto">v1/sheet_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.BatchCreateSheetsRequest">BatchCreateSheetsRequest</h3>
- <p></p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
@@ -32011,39 +32019,52 @@ Permissions required: bb.serviceAccounts.undelete</p></td>
<td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource where all sheets will be created.
+ <td><p>The parent resource of the saved queries.
Format: projects/{project} </p></td>
</tr>
<tr>
- <td>requests</td>
- <td><a href="#bytebase.v1.CreateSheetRequest">CreateSheetRequest</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
+ <td>filter</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>To filter the search result.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-
- <h3 id="bytebase.v1.BatchCreateSheetsResponse">BatchCreateSheetsResponse</h3>
- <p></p>
+Supported filter:
+- name: the saved query name in &#34;projects/{project}/savedQueries/{savedQuery}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator.
+- title: the saved query title, support &#34;contains&#34; operator.
+- creator: the saved query creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
+- starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred saved queries, support &#34;==&#34; operator.
+- visibility: check Visibility enum in the SavedQuery message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator.
+- folder: the saved query organizer folder path, support &#34;==&#34; operator.
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+For example:
+creator == &#34;users/{email}&#34;
+title.contains(&#34;saved query title&#34;)
+creator != &#34;users/{email}&#34;
+starred == true
+starred == false
+visibility in [&#34;PRIVATE&#34;, &#34;PROJECT_READ&#34;, &#34;PROJECT_WRITE&#34;]
+visibility == &#34;PRIVATE&#34;
+folder == &#34;foo/bar&#34; </p></td>
+ </tr>
<tr>
- <td>sheets</td>
- <td><a href="#bytebase.v1.Sheet">Sheet</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p>The maximum number of saved queries to return. The service may return fewer than
+this value.
+If unspecified, at most 10 saved queries will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ </tr>
+
+ <tr>
+ <td>page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A page token, received from a previous `SearchSavedQueries` call.
+Provide this to retrieve the subsequent page. </p></td>
</tr>
</tbody>
@@ -32053,7 +32074,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.CreateSheetRequest">CreateSheetRequest</h3>
+ <h3 id="bytebase.v1.SearchSavedQueriesResponse">SearchSavedQueriesResponse</h3>
<p></p>
@@ -32064,18 +32085,19 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent resource where this sheet will be created.
-Format: projects/{project} </p></td>
+ <td>saved_queries</td>
+ <td><a href="#bytebase.v1.SavedQuery">SavedQuery</a></td>
+ <td>repeated</td>
+ <td><p>The saved queries that matched the search criteria. </p></td>
</tr>
<tr>
- <td>sheet</td>
- <td><a href="#bytebase.v1.Sheet">Sheet</a></td>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The sheet to create. </p></td>
+ <td><p>A token to retrieve next page of saved queries.
+Pass this value in the page_token field in the subsequent call to
+`SearchSavedQueries` method to retrieve the next page of saved queries. </p></td>
</tr>
</tbody>
@@ -32085,7 +32107,7 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.GetSheetRequest">GetSheetRequest</h3>
+ <h3 id="bytebase.v1.UpdateSavedQueryOrganizerRequest">UpdateSavedQueryOrganizerRequest</h3>
<p></p>
@@ -32096,18 +32118,31 @@ Format: projects/{project} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>organizer</td>
+ <td><a href="#bytebase.v1.SavedQueryOrganizer">SavedQueryOrganizer</a></td>
<td></td>
- <td><p>The name of the sheet to retrieve.
-Format: projects/{project}/sheets/{sheet} </p></td>
+ <td><p>The organizer to update.
+
+The organizer&#39;s `saved_query` field is used to identify the saved query.
+Format: projects/{project}/savedQueries/{savedQuery} </p></td>
</tr>
<tr>
- <td>raw</td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td></td>
+ <td><p>The list of fields to be updated.
+Fields are specified relative to the saved query organizer.
+Only support update the following fields for now:
+- `starred` </p></td>
+ </tr>
+
+ <tr>
+ <td>allow_missing</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>By default, the content of the sheet is cut off, set the `raw` to true to retrieve the full content. </p></td>
+ <td><p>If set to true, and the saved query organizer is not found, a new saved query organizer will be created.
+In this situation, `update_mask` is ignored. </p></td>
</tr>
</tbody>
@@ -32117,7 +32152,7 @@ Format: projects/{project}/sheets/{sheet} </p></td>
- <h3 id="bytebase.v1.Sheet">Sheet</h3>
+ <h3 id="bytebase.v1.UpdateSavedQueryRequest">UpdateSavedQueryRequest</h3>
<p></p>
@@ -32128,28 +32163,27 @@ Format: projects/{project}/sheets/{sheet} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The name of the sheet resource.
-Format: projects/{project}/sheets/{sheet}
-The sheet ID is generated by the server on creation and cannot be changed. </p></td>
- </tr>
-
- <tr>
- <td>content</td>
- <td><a href="#bytes">bytes</a></td>
+ <td>saved_query</td>
+ <td><a href="#bytebase.v1.SavedQuery">SavedQuery</a></td>
<td></td>
- <td><p>The content of the sheet.
-By default, it will be cut off, if it doesn&#39;t match the `content_size`, you can
-set the `raw` to true in GetSheet request to retrieve the full content. </p></td>
+ <td><p>The saved query to update.
+
+The saved query&#39;s `name` field is used to identify the saved query to update.
+Format: projects/{project}/savedQueries/{savedQuery} </p></td>
</tr>
<tr>
- <td>content_size</td>
- <td><a href="#int64">int64</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>content_size is the full size of the content, may not match the size of the `content` field. </p></td>
+ <td><p>The list of fields to be updated.
+Fields are specified relative to the saved query.
+(e.g., `title`, `statement`; *not* `saved_query.title` or `saved_query.statement`)
+Only support update the following fields for now:
+- `title`
+- `statement`
+- `starred`
+- `visibility` </p></td>
</tr>
</tbody>
@@ -32161,76 +32195,232 @@ set the `raw` to true in GetSheet request to retrieve the full content. </p></td
-
-
-
-
- <h3 id="bytebase.v1.SheetService">SheetService</h3>
- <p>SheetService manages SQL scripts and saved queries.</p>
+ <h3 id="bytebase.v1.SavedQuery.Visibility">SavedQuery.Visibility</h3>
+ <p></p>
<table class="enum-table">
<thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>CreateSheet</td>
- <td><a href="#bytebase.v1.CreateSheetRequest">CreateSheetRequest</a></td>
- <td><a href="#bytebase.v1.Sheet">Sheet</a></td>
- <td><p>Creates a new SQL sheet.
-Permissions required: bb.sheets.create</p></td>
+ <td>VISIBILITY_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
</tr>
<tr>
- <td>BatchCreateSheets</td>
- <td><a href="#bytebase.v1.BatchCreateSheetsRequest">BatchCreateSheetsRequest</a></td>
- <td><a href="#bytebase.v1.BatchCreateSheetsResponse">BatchCreateSheetsResponse</a></td>
- <td><p>Creates multiple SQL sheets in a single operation.
-Permissions required: bb.sheets.create</p></td>
+ <td>PROJECT_READ</td>
+ <td>1</td>
+ <td><p>Read access in project scope, saved query OWNER/DBA and project OWNER can read/write, other project members can read.</p></td>
</tr>
<tr>
- <td>GetSheet</td>
- <td><a href="#bytebase.v1.GetSheetRequest">GetSheetRequest</a></td>
- <td><a href="#bytebase.v1.Sheet">Sheet</a></td>
- <td><p>Retrieves a SQL sheet by name.
-Permissions required: bb.sheets.get</p></td>
+ <td>PROJECT_WRITE</td>
+ <td>2</td>
+ <td><p>Write access in project scope, saved query OWNER/DBA and all members in the project can write the saved query.</p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
- <h4>Methods with HTTP bindings</h4>
- <table>
- <thead>
<tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
+ <td>PRIVATE</td>
+ <td>3</td>
+ <td><p>Private, only saved query OWNER can read/write.</p></td>
</tr>
- </thead>
- <tbody>
-
-
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.SavedQueryFolder.Category">SavedQueryFolder.Category</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
<tr>
- <td>CreateSheet</td>
+ <td>CATEGORY_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>MINE</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>SHARED</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.SavedQueryService">SavedQueryService</h3>
+ <p>SavedQueryService manages saved queries for SQL Editor query development.</p><p>Permission IDs still use the legacy `bb.worksheets.*` names; they are</p><p>renamed together with the access-model redesign and its role migration.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>CreateSavedQuery</td>
+ <td><a href="#bytebase.v1.CreateSavedQueryRequest">CreateSavedQueryRequest</a></td>
+ <td><a href="#bytebase.v1.SavedQuery">SavedQuery</a></td>
+ <td><p>Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries.
+Permissions required: None (authenticated users only)</p></td>
+ </tr>
+
+ <tr>
+ <td>GetSavedQuery</td>
+ <td><a href="#bytebase.v1.GetSavedQueryRequest">GetSavedQueryRequest</a></td>
+ <td><a href="#bytebase.v1.SavedQuery">SavedQuery</a></td>
+ <td><p>Get a saved query by name.
+The users can access this method if,
+- they are the creator of the saved query;
+- they have bb.worksheets.get permission on the workspace;
+- the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)</p></td>
+ </tr>
+
+ <tr>
+ <td>ListSavedQueries</td>
+ <td><a href="#bytebase.v1.ListSavedQueriesRequest">ListSavedQueriesRequest</a></td>
+ <td><a href="#bytebase.v1.ListSavedQueriesResponse">ListSavedQueriesResponse</a></td>
+ <td><p>List saved queries.
+This is used for listing saved queries in a project, or across all projects by using `projects/-`.
+Permissions required: bb.worksheets.list</p></td>
+ </tr>
+
+ <tr>
+ <td>ListSavedQueryFolders</td>
+ <td><a href="#bytebase.v1.ListSavedQueryFoldersRequest">ListSavedQueryFoldersRequest</a></td>
+ <td><a href="#bytebase.v1.ListSavedQueryFoldersResponse">ListSavedQueryFoldersResponse</a></td>
+ <td><p>List the caller&#39;s saved query folders.
+Only folders stored in the caller&#39;s saved query organizer are returned.</p></td>
+ </tr>
+
+ <tr>
+ <td>SearchSavedQueries</td>
+ <td><a href="#bytebase.v1.SearchSavedQueriesRequest">SearchSavedQueriesRequest</a></td>
+ <td><a href="#bytebase.v1.SearchSavedQueriesResponse">SearchSavedQueriesResponse</a></td>
+ <td><p>Search for saved queries.
+This is used for finding my saved queries or saved queries shared by other people.
+The saved query accessibility is the same as GetSavedQuery().
+Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateSavedQuery</td>
+ <td><a href="#bytebase.v1.UpdateSavedQueryRequest">UpdateSavedQueryRequest</a></td>
+ <td><a href="#bytebase.v1.SavedQuery">SavedQuery</a></td>
+ <td><p>Update a saved query.
+The users can access this method if,
+- they are the creator of the saved query;
+- they have bb.worksheets.manage permission on the workspace;
+- the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateSavedQueryOrganizer</td>
+ <td><a href="#bytebase.v1.UpdateSavedQueryOrganizerRequest">UpdateSavedQueryOrganizerRequest</a></td>
+ <td><a href="#bytebase.v1.SavedQueryOrganizer">SavedQueryOrganizer</a></td>
+ <td><p>Update the organizer of a saved query.
+The access is the same as UpdateSavedQuery method.
+Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)</p></td>
+ </tr>
+
+ <tr>
+ <td>BatchUpdateSavedQueryOrganizer</td>
+ <td><a href="#bytebase.v1.BatchUpdateSavedQueryOrganizerRequest">BatchUpdateSavedQueryOrganizerRequest</a></td>
+ <td><a href="#bytebase.v1.BatchUpdateSavedQueryOrganizerResponse">BatchUpdateSavedQueryOrganizerResponse</a></td>
+ <td><p>Batch update the organizers of saved queries.
+The access is the same as UpdateSavedQuery method.
+Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteSavedQuery</td>
+ <td><a href="#bytebase.v1.DeleteSavedQueryRequest">DeleteSavedQueryRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Delete a saved query.
+The access is the same as UpdateSavedQuery method.
+Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)</p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
+ </thead>
+ <tbody>
+
+
+
+ <tr>
+ <td>CreateSavedQuery</td>
<td>POST</td>
- <td>/v1/{parent=projects/*}/sheets</td>
- <td>sheet</td>
+ <td>/v1/{parent=projects/*}/savedQueries</td>
+ <td>saved_query</td>
</tr>
<tr>
- <td>BatchCreateSheets</td>
+ <td>GetSavedQuery</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/savedQueries/*}</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListSavedQueries</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/savedQueries</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>ListSavedQueryFolders</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/savedQueryFolders</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>SearchSavedQueries</td>
<td>POST</td>
- <td>/v1/{parent=projects/*}/sheets:batchCreate</td>
+ <td>/v1/{parent=projects/*}/savedQueries:search</td>
<td>*</td>
</tr>
@@ -32238,9 +32428,39 @@ Permissions required: bb.sheets.get</p></td>
<tr>
- <td>GetSheet</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/sheets/*}</td>
+ <td>UpdateSavedQuery</td>
+ <td>PATCH</td>
+ <td>/v1/{saved_query.name=projects/*/savedQueries/*}</td>
+ <td>saved_query</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateSavedQueryOrganizer</td>
+ <td>PATCH</td>
+ <td>/v1/{organizer.saved_query=projects/*/savedQueries/*}/organizer</td>
+ <td>organizer</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>BatchUpdateSavedQueryOrganizer</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/savedQueries/organizers:batchUpdate</td>
+ <td>*</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteSavedQuery</td>
+ <td>DELETE</td>
+ <td>/v1/{name=projects/*/savedQueries/*}</td>
<td></td>
</tr>
@@ -32252,13 +32472,13 @@ Permissions required: bb.sheets.get</p></td>
<div class="file-heading">
- <h2 id="v1/subscription_service.proto">v1/subscription_service.proto</h2><a href="#title">Top</a>
+ <h2 id="v1/service_account_service.proto">v1/service_account_service.proto</h2><a href="#title">Top</a>
</div>
<p></p>
- <h3 id="bytebase.v1.CancelPurchaseRequest">CancelPurchaseRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.CreateServiceAccountRequest">CreateServiceAccountRequest</h3>
+ <p>Request message for creating a service account.</p>
<table class="field-table">
@@ -32268,20 +32488,27 @@ Permissions required: bb.sheets.get</p></td>
<tbody>
<tr>
- <td>feedback</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Reason the customer is canceling. Maps to Stripe&#39;s cancellation_details.feedback.
-Valid Stripe values: &#34;customer_service&#34;, &#34;low_quality&#34;, &#34;missing_features&#34;,
-&#34;switched_service&#34;, &#34;too_complex&#34;, &#34;too_expensive&#34;, &#34;unused&#34;, &#34;other&#34;.
-Required. </p></td>
+ <td><p>The parent resource where this service account will be created.
+Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td>
</tr>
<tr>
- <td>comment</td>
+ <td>service_account_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Optional free-form comment. Max 500 chars (Stripe limit). </p></td>
+ <td><p>The ID to use for the service account, which will become the final component
+of the service account&#39;s email in the format: {service_account_id}@service.bytebase.com
+or {service_account_id}@{project-id}.service.bytebase.com </p></td>
+ </tr>
+
+ <tr>
+ <td>service_account</td>
+ <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
+ <td></td>
+ <td><p>The service account to create. </p></td>
</tr>
</tbody>
@@ -32291,8 +32518,8 @@ Required. </p></td>
- <h3 id="bytebase.v1.CreatePurchaseRequest">CreatePurchaseRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DeleteServiceAccountRequest">DeleteServiceAccountRequest</h3>
+ <p>Request message for deleting a service account.</p>
<table class="field-table">
@@ -32302,24 +32529,11 @@ Required. </p></td>
<tbody>
<tr>
- <td>plan</td>
- <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>interval</td>
- <td><a href="#bytebase.v1.BillingInterval">BillingInterval</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>seats</td>
- <td><a href="#int32">int32</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the service account to delete.
+Format: serviceAccounts/{email} </p></td>
</tr>
</tbody>
@@ -32329,36 +32543,8 @@ Required. </p></td>
- <h3 id="bytebase.v1.ExportVCSProviderUsersRequest">ExportVCSProviderUsersRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.GetPaymentInfoRequest">GetPaymentInfoRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.GetSubscriptionRequest">GetSubscriptionRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.ListPurchasePlansRequest">ListPurchasePlansRequest</h3>
- <p></p>
-
-
-
-
-
- <h3 id="bytebase.v1.ListPurchasePlansResponse">ListPurchasePlansResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetServiceAccountRequest">GetServiceAccountRequest</h3>
+ <p>Request message for getting a service account.</p>
<table class="field-table">
@@ -32368,10 +32554,11 @@ Required. </p></td>
<tbody>
<tr>
- <td>plans</td>
- <td><a href="#bytebase.v1.PurchasePlan">PurchasePlan</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the service account to retrieve.
+Format: serviceAccounts/{email} </p></td>
</tr>
</tbody>
@@ -32381,8 +32568,8 @@ Required. </p></td>
- <h3 id="bytebase.v1.PaymentInfo">PaymentInfo</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListServiceAccountsRequest">ListServiceAccountsRequest</h3>
+ <p>Request message for listing service accounts.</p>
<table class="field-table">
@@ -32392,53 +32579,59 @@ Required. </p></td>
<tbody>
<tr>
- <td>total_price</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Total amount paid for the current billing period, in the smallest currency unit (e.g. cents). </p></td>
+ <td><p>The parent resource.
+Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td>
</tr>
<tr>
- <td>currency</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>period_start</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>period_end</td>
- <td><a href="#string">string</a></td>
+ <td>page_size</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The maximum number of service accounts to return. The service may return fewer than
+this value.
+If unspecified, at most 10 service accounts will be returned.
+The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
<tr>
- <td>invoice_url</td>
+ <td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Stripe Billing Portal URL for invoice management. </p></td>
+ <td><p>A page token, received from a previous `ListServiceAccounts` call.
+Provide this to retrieve the subsequent page.
+
+When paginating, all other parameters provided to `ListServiceAccounts` must match
+the call that provided the page token. </p></td>
</tr>
<tr>
- <td>cancel_at_period_end</td>
+ <td>show_deleted</td>
<td><a href="#bool">bool</a></td>
<td></td>
- <td><p>Whether the subscription is scheduled to cancel at the end of the current billing period. </p></td>
+ <td><p>Show deleted service accounts if specified. </p></td>
</tr>
<tr>
- <td>next_period_price</td>
+ <td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Amount that will be charged at the next renewal, in the smallest currency unit (e.g. cents).
-Empty when the subscription will not renew (e.g. scheduled to cancel at period end). </p></td>
+ <td><p>Filter is used to filter service accounts returned in the list.
+The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+
+Supported filter:
+- name: the service account name, support &#34;==&#34; and &#34;.contains()&#34; operator.
+- email: the service account email, support &#34;==&#34; and &#34;.contains()&#34; operator.
+- state: check State enum for values, support &#34;==&#34; operator.
+
+For example:
+name == &#34;ed&#34;
+name.contains(&#34;ed&#34;)
+state == &#34;DELETED&#34;
+email == &#34;[email protected]&#34;
+email.contains(&#34;ed&#34;) </p></td>
</tr>
</tbody>
@@ -32448,8 +32641,8 @@ Empty when the subscription will not renew (e.g. scheduled to cancel at period e
- <h3 id="bytebase.v1.PlanConfig">PlanConfig</h3>
- <p>PlanConfig represents the configuration for all plans loaded from plan.yaml</p>
+ <h3 id="bytebase.v1.ListServiceAccountsResponse">ListServiceAccountsResponse</h3>
+ <p>Response message for listing service accounts.</p>
<table class="field-table">
@@ -32459,17 +32652,18 @@ Empty when the subscription will not renew (e.g. scheduled to cancel at period e
<tbody>
<tr>
- <td>plans</td>
- <td><a href="#bytebase.v1.PlanLimitConfig">PlanLimitConfig</a></td>
+ <td>service_accounts</td>
+ <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
<td>repeated</td>
- <td><p> </p></td>
+ <td><p>The service accounts from the specified request. </p></td>
</tr>
<tr>
- <td>instance_features</td>
- <td><a href="#bytebase.v1.PlanFeature">PlanFeature</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>next_page_token</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
</tbody>
@@ -32479,8 +32673,8 @@ Empty when the subscription will not renew (e.g. scheduled to cancel at period e
- <h3 id="bytebase.v1.PlanLimitConfig">PlanLimitConfig</h3>
- <p>PlanLimitConfig represents a single plan's configuration</p>
+ <h3 id="bytebase.v1.ServiceAccount">ServiceAccount</h3>
+ <p>ServiceAccount represents an API integration account.</p>
<table class="field-table">
@@ -32490,62 +32684,48 @@ Empty when the subscription will not renew (e.g. scheduled to cancel at period e
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the service account.
+Format: serviceAccounts/{email} </p></td>
</tr>
<tr>
- <td>maximum_instance_count</td>
- <td><a href="#int32">int32</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The state of the service account. </p></td>
</tr>
<tr>
- <td>maximum_seat_count</td>
- <td><a href="#int32">int32</a></td>
+ <td>email</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The email of the service account.
+For workspace-level: {name}@service.bytebase.com
+For project-level: {name}@{project-id}.service.bytebase.com </p></td>
</tr>
<tr>
- <td>features</td>
- <td><a href="#bytebase.v1.PlanFeature">PlanFeature</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td>title</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The display title of the service account. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.PurchaseBillingMethod">PurchaseBillingMethod</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>interval</td>
- <td><a href="#bytebase.v1.BillingInterval">BillingInterval</a></td>
+ <td>service_key</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The service key for authentication. Only returned on creation or key rotation. </p></td>
</tr>
<tr>
- <td>discount</td>
- <td><a href="#bytebase.v1.PurchaseDiscount">PurchaseDiscount</a></td>
+ <td>create_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The timestamp when the service account was created. </p></td>
</tr>
</tbody>
@@ -32555,8 +32735,8 @@ Empty when the subscription will not renew (e.g. scheduled to cancel at period e
- <h3 id="bytebase.v1.PurchaseDiscount">PurchaseDiscount</h3>
- <p></p>
+ <h3 id="bytebase.v1.UndeleteServiceAccountRequest">UndeleteServiceAccountRequest</h3>
+ <p>Request message for restoring a deleted service account.</p>
<table class="field-table">
@@ -32566,17 +32746,11 @@ Empty when the subscription will not renew (e.g. scheduled to cancel at period e
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.PurchaseDiscount.Type">PurchaseDiscount.Type</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>value</td>
- <td><a href="#int32">int32</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The name of the deleted service account.
+Format: serviceAccounts/{email} </p></td>
</tr>
</tbody>
@@ -32586,8 +32760,8 @@ Empty when the subscription will not renew (e.g. scheduled to cancel at period e
- <h3 id="bytebase.v1.PurchasePlan">PurchasePlan</h3>
- <p></p>
+ <h3 id="bytebase.v1.UpdateServiceAccountRequest">UpdateServiceAccountRequest</h3>
+ <p>Request message for updating a service account.</p>
<table class="field-table">
@@ -32597,31 +32771,21 @@ Empty when the subscription will not renew (e.g. scheduled to cancel at period e
<tbody>
<tr>
- <td>type</td>
- <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
+ <td>service_account</td>
+ <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The service account to update.
+
+The service account&#39;s `name` field is used to identify the service account to update.
+Format: serviceAccounts/{email} </p></td>
</tr>
<tr>
- <td>self_service_purchase</td>
- <td><a href="#bool">bool</a></td>
+ <td>update_mask</td>
+ <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>additionals</td>
- <td><a href="#bytebase.v1.PurchasePlanAdditional">PurchasePlanAdditional</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>billing_methods</td>
- <td><a href="#bytebase.v1.PurchaseBillingMethod">PurchaseBillingMethod</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td><p>The list of fields to update.
+Supported fields: title, service_key (triggers key rotation) </p></td>
</tr>
</tbody>
@@ -32631,171 +32795,175 @@ Empty when the subscription will not renew (e.g. scheduled to cancel at period e
- <h3 id="bytebase.v1.PurchasePlanAdditional">PurchasePlanAdditional</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>type</td>
- <td><a href="#bytebase.v1.PurchasePlanAdditional.Type">PurchasePlanAdditional.Type</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>unit_price</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>Price in USD cents per month. </p></td>
- </tr>
-
- <tr>
- <td>free_count</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>minimum_count</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>maximum_count</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>-1 means unlimited. </p></td>
- </tr>
-
- </tbody>
- </table>
-
+
-
- <h3 id="bytebase.v1.PurchaseResponse">PurchaseResponse</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>payment_url</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>If set, redirect to this Stripe Checkout URL.
-If empty, the update was applied directly using the existing payment method. </p></td>
- </tr>
-
- <tr>
- <td>session_id</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Stripe Checkout Session ID. Used to verify the session after redirect. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <h3 id="bytebase.v1.Subscription">Subscription</h3>
- <p></p>
+ <h3 id="bytebase.v1.ServiceAccountService">ServiceAccountService</h3>
+ <p>ServiceAccountService manages service accounts for API integrations.</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>CreateServiceAccount</td>
+ <td><a href="#bytebase.v1.CreateServiceAccountRequest">CreateServiceAccountRequest</a></td>
+ <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
+ <td><p>Creates a new service account.
+For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.create on workspace.
+For project-level: parent is projects/{project}, permission bb.serviceAccounts.create on project.</p></td>
+ </tr>
+
+ <tr>
+ <td>GetServiceAccount</td>
+ <td><a href="#bytebase.v1.GetServiceAccountRequest">GetServiceAccountRequest</a></td>
+ <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
+ <td><p>Gets a service account by name.
+Permissions required: bb.serviceAccounts.get</p></td>
+ </tr>
+
+ <tr>
+ <td>ListServiceAccounts</td>
+ <td><a href="#bytebase.v1.ListServiceAccountsRequest">ListServiceAccountsRequest</a></td>
+ <td><a href="#bytebase.v1.ListServiceAccountsResponse">ListServiceAccountsResponse</a></td>
+ <td><p>Lists service accounts.
+For workspace-level: parent is workspaces/{id}, permission bb.serviceAccounts.list on workspace.
+For project-level: parent is projects/{project}, permission bb.serviceAccounts.list on project.</p></td>
+ </tr>
+
+ <tr>
+ <td>UpdateServiceAccount</td>
+ <td><a href="#bytebase.v1.UpdateServiceAccountRequest">UpdateServiceAccountRequest</a></td>
+ <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
+ <td><p>Updates a service account.
+Permissions required: bb.serviceAccounts.update</p></td>
+ </tr>
+
+ <tr>
+ <td>DeleteServiceAccount</td>
+ <td><a href="#bytebase.v1.DeleteServiceAccountRequest">DeleteServiceAccountRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a service account.
+Permissions required: bb.serviceAccounts.delete</p></td>
+ </tr>
+
+ <tr>
+ <td>UndeleteServiceAccount</td>
+ <td><a href="#bytebase.v1.UndeleteServiceAccountRequest">UndeleteServiceAccountRequest</a></td>
+ <td><a href="#bytebase.v1.ServiceAccount">ServiceAccount</a></td>
+ <td><p>Restores a deleted service account.
+Permissions required: bb.serviceAccounts.undelete</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <table class="field-table">
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
<thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ <tr>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
+ </tr>
</thead>
<tbody>
+
- <tr>
- <td>plan</td>
- <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>seats</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>CreateServiceAccount</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/serviceAccounts</td>
+ <td>service_account</td>
+ </tr>
- <tr>
- <td>instances</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>CreateServiceAccount</td>
+ <td>POST</td>
+ <td>/v1/{parent=workspaces/*}/serviceAccounts</td>
+ <td>service_account</td>
+ </tr>
- <tr>
- <td>active_instances</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>expires_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>trialing</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>GetServiceAccount</td>
+ <td>GET</td>
+ <td>/v1/{name=serviceAccounts/*}</td>
+ <td></td>
+ </tr>
- <tr>
- <td>org_name</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+
- <tr>
- <td>ha</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>Whether high availability (multiple replicas) is enabled. </p></td>
- </tr>
- <tr>
- <td>etag</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>Etag for optimistic concurrency on purchase updates. Only set in SaaS mode. </p></td>
- </tr>
+ <tr>
+ <td>ListServiceAccounts</td>
+ <td>GET</td>
+ <td>/v1/{parent=projects/*}/serviceAccounts</td>
+ <td></td>
+ </tr>
+
+ <tr>
+ <td>ListServiceAccounts</td>
+ <td>GET</td>
+ <td>/v1/{parent=workspaces/*}/serviceAccounts</td>
+ <td></td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>UpdateServiceAccount</td>
+ <td>PATCH</td>
+ <td>/v1/{service_account.name=serviceAccounts/*}</td>
+ <td>service_account</td>
+ </tr>
+
+
+
+
+ <tr>
+ <td>DeleteServiceAccount</td>
+ <td>DELETE</td>
+ <td>/v1/{name=serviceAccounts/*}</td>
+ <td></td>
+ </tr>
+
+
+
+ <tr>
+ <td>UndeleteServiceAccount</td>
+ <td>POST</td>
+ <td>/v1/{name=serviceAccounts/*}:undelete</td>
+ <td>*</td>
+ </tr>
+
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.UpdatePurchaseRequest">UpdatePurchaseRequest</h3>
+ <div class="file-heading">
+ <h2 id="v1/sheet_service.proto">v1/sheet_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.BatchCreateSheetsRequest">BatchCreateSheetsRequest</h3>
<p></p>
@@ -32806,30 +32974,17 @@ If empty, the update was applied directly using the existing payment method. </p
<tbody>
<tr>
- <td>plan</td>
- <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>interval</td>
- <td><a href="#bytebase.v1.BillingInterval">BillingInterval</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
-
- <tr>
- <td>seats</td>
- <td><a href="#int32">int32</a></td>
+ <td>parent</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The parent resource where all sheets will be created.
+Format: projects/{project} </p></td>
</tr>
<tr>
- <td>etag</td>
- <td><a href="#string">string</a></td>
- <td></td>
+ <td>requests</td>
+ <td><a href="#bytebase.v1.CreateSheetRequest">CreateSheetRequest</a></td>
+ <td>repeated</td>
<td><p> </p></td>
</tr>
@@ -32840,7 +32995,7 @@ If empty, the update was applied directly using the existing payment method. </p
- <h3 id="bytebase.v1.UploadLicenseRequest">UploadLicenseRequest</h3>
+ <h3 id="bytebase.v1.BatchCreateSheetsResponse">BatchCreateSheetsResponse</h3>
<p></p>
@@ -32851,9 +33006,9 @@ If empty, the update was applied directly using the existing payment method. </p
<tbody>
<tr>
- <td>license</td>
- <td><a href="#string">string</a></td>
- <td></td>
+ <td>sheets</td>
+ <td><a href="#bytebase.v1.Sheet">Sheet</a></td>
+ <td>repeated</td>
<td><p> </p></td>
</tr>
@@ -32864,7 +33019,7 @@ If empty, the update was applied directly using the existing payment method. </p
- <h3 id="bytebase.v1.VerifyCheckoutSessionRequest">VerifyCheckoutSessionRequest</h3>
+ <h3 id="bytebase.v1.CreateSheetRequest">CreateSheetRequest</h3>
<p></p>
@@ -32875,20 +33030,28 @@ If empty, the update was applied directly using the existing payment method. </p
<tbody>
<tr>
- <td>session_id</td>
+ <td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p> </p></td>
+ <td><p>The parent resource where this sheet will be created.
+Format: projects/{project} </p></td>
</tr>
- </tbody>
- </table>
-
+ <tr>
+ <td>sheet</td>
+ <td><a href="#bytebase.v1.Sheet">Sheet</a></td>
+ <td></td>
+ <td><p>The sheet to create. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
- <h3 id="bytebase.v1.VerifyCheckoutSessionResponse">VerifyCheckoutSessionResponse</h3>
+ <h3 id="bytebase.v1.GetSheetRequest">GetSheetRequest</h3>
<p></p>
@@ -32899,10 +33062,60 @@ If empty, the update was applied directly using the existing payment method. </p
<tbody>
<tr>
- <td>status</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Stripe Checkout Session status: &#34;complete&#34;, &#34;expired&#34;, or &#34;open&#34;. </p></td>
+ <td><p>The name of the sheet to retrieve.
+Format: projects/{project}/sheets/{sheet} </p></td>
+ </tr>
+
+ <tr>
+ <td>raw</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>By default, the content of the sheet is cut off, set the `raw` to true to retrieve the full content. </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.Sheet">Sheet</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>name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>The name of the sheet resource.
+Format: projects/{project}/sheets/{sheet}
+The sheet ID is generated by the server on creation and cannot be changed. </p></td>
+ </tr>
+
+ <tr>
+ <td>content</td>
+ <td><a href="#bytes">bytes</a></td>
+ <td></td>
+ <td><p>The content of the sheet.
+By default, it will be cut off, if it doesn&#39;t match the `content_size`, you can
+set the `raw` to true in GetSheet request to retrieve the full content. </p></td>
+ </tr>
+
+ <tr>
+ <td>content_size</td>
+ <td><a href="#int64">int64</a></td>
+ <td></td>
+ <td><p>content_size is the full size of the content, may not match the size of the `content` field. </p></td>
</tr>
</tbody>
@@ -32914,772 +33127,371 @@ If empty, the update was applied directly using the existing payment method. </p
- <h3 id="bytebase.v1.BillingInterval">BillingInterval</h3>
- <p></p>
+
+
+
+
+ <h3 id="bytebase.v1.SheetService">SheetService</h3>
+ <p>SheetService manages SQL scripts and saved queries.</p>
<table class="enum-table">
<thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
- <td>BILLING_INTERVAL_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
+ <td>CreateSheet</td>
+ <td><a href="#bytebase.v1.CreateSheetRequest">CreateSheetRequest</a></td>
+ <td><a href="#bytebase.v1.Sheet">Sheet</a></td>
+ <td><p>Creates a new SQL sheet.
+Permissions required: bb.sheets.create</p></td>
</tr>
<tr>
- <td>MONTH</td>
- <td>1</td>
- <td><p></p></td>
+ <td>BatchCreateSheets</td>
+ <td><a href="#bytebase.v1.BatchCreateSheetsRequest">BatchCreateSheetsRequest</a></td>
+ <td><a href="#bytebase.v1.BatchCreateSheetsResponse">BatchCreateSheetsResponse</a></td>
+ <td><p>Creates multiple SQL sheets in a single operation.
+Permissions required: bb.sheets.create</p></td>
</tr>
<tr>
- <td>YEAR</td>
- <td>2</td>
- <td><p></p></td>
+ <td>GetSheet</td>
+ <td><a href="#bytebase.v1.GetSheetRequest">GetSheetRequest</a></td>
+ <td><a href="#bytebase.v1.Sheet">Sheet</a></td>
+ <td><p>Retrieves a SQL sheet by name.
+Permissions required: bb.sheets.get</p></td>
</tr>
</tbody>
</table>
-
- <h3 id="bytebase.v1.PlanFeature">PlanFeature</h3>
- <p>PlanFeature represents the available features in Bytebase</p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>FEATURE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DATABASE_CHANGE</td>
- <td>1</td>
- <td><p>Database Change Management</p></td>
- </tr>
-
- <tr>
- <td>FEATURE_GIT_BASED_SCHEMA_VERSION_CONTROL</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DECLARATIVE_SCHEMA_MIGRATION</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_COMPARE_AND_SYNC_SCHEMA</td>
- <td>4</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_ONLINE_SCHEMA_CHANGE</td>
- <td>5</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_PRE_DEPLOYMENT_SQL_REVIEW</td>
- <td>6</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_AUTOMATIC_BACKUP_BEFORE_DATA_CHANGES</td>
- <td>7</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_ONE_CLICK_DATA_ROLLBACK</td>
- <td>8</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_MULTI_DATABASE_BATCH_CHANGES</td>
- <td>9</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_PROGRESSIVE_ENVIRONMENT_DEPLOYMENT</td>
- <td>10</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_SCHEDULED_ROLLOUT_TIME</td>
- <td>11</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DATABASE_CHANGELOG</td>
- <td>12</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_SCHEMA_DRIFT_DETECTION</td>
- <td>13</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_ROLLOUT_POLICY</td>
- <td>14</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_WEB_BASED_SQL_EDITOR</td>
- <td>15</td>
- <td><p>SQL Editor &amp; Development</p></td>
- </tr>
-
+
+
+
+
+ <h4>Methods with HTTP bindings</h4>
+ <table>
+ <thead>
<tr>
- <td>FEATURE_SQL_EDITOR_ADMIN_MODE</td>
- <td>16</td>
- <td><p></p></td>
+ <td>Method Name</td>
+ <td>Method</td>
+ <td>Pattern</td>
+ <td>Body</td>
</tr>
+ </thead>
+ <tbody>
+
+
<tr>
- <td>FEATURE_NATURAL_LANGUAGE_TO_SQL</td>
- <td>17</td>
- <td><p></p></td>
+ <td>CreateSheet</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/sheets</td>
+ <td>sheet</td>
</tr>
+
+
+
<tr>
- <td>FEATURE_AI_QUERY_EXPLANATION</td>
- <td>18</td>
- <td><p></p></td>
+ <td>BatchCreateSheets</td>
+ <td>POST</td>
+ <td>/v1/{parent=projects/*}/sheets:batchCreate</td>
+ <td>*</td>
</tr>
+
+
+
<tr>
- <td>FEATURE_AI_QUERY_SUGGESTIONS</td>
- <td>19</td>
- <td><p></p></td>
+ <td>GetSheet</td>
+ <td>GET</td>
+ <td>/v1/{name=projects/*/sheets/*}</td>
+ <td></td>
</tr>
+
- <tr>
- <td>FEATURE_AUTO_COMPLETE</td>
- <td>20</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_SCHEMA_DIAGRAM</td>
- <td>21</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_SCHEMA_EDITOR</td>
- <td>22</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DATA_EXPORT</td>
- <td>23</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DATA_OFFLINE_EXPORT</td>
- <td>24</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_QUERY_HISTORY</td>
- <td>25</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_SAVED_AND_SHARED_SQL_SCRIPTS</td>
- <td>26</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_BATCH_QUERY</td>
- <td>27</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_INSTANCE_READ_ONLY_CONNECTION</td>
- <td>28</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_QUERY_POLICY</td>
- <td>29</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_RESTRICT_COPYING_DATA</td>
- <td>30</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_IAM</td>
- <td>31</td>
- <td><p>Security &amp; Compliance</p></td>
- </tr>
-
- <tr>
- <td>FEATURE_INSTANCE_SSL_CONNECTION</td>
- <td>32</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_INSTANCE_CONNECTION_OVER_SSH_TUNNEL</td>
- <td>33</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_INSTANCE_CONNECTION_IAM_AUTHENTICATION</td>
- <td>34</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_GOOGLE_AND_GITHUB_SSO</td>
- <td>35</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_USER_GROUPS</td>
- <td>36</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DISALLOW_SELF_SERVICE_SIGNUP</td>
- <td>37</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_CUSTOM_INSTANCE_SYNC_TIME</td>
- <td>38</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_CUSTOM_INSTANCE_CONNECTION_LIMIT</td>
- <td>39</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_RISK_ASSESSMENT</td>
- <td>40</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_APPROVAL_WORKFLOW</td>
- <td>41</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_AUDIT_LOG</td>
- <td>42</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_ENTERPRISE_SSO</td>
- <td>43</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_TWO_FA</td>
- <td>44</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_PASSWORD_RESTRICTIONS</td>
- <td>45</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DISALLOW_PASSWORD_SIGNIN</td>
- <td>46</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_CUSTOM_ROLES</td>
- <td>47</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_REQUEST_ROLE_WORKFLOW</td>
- <td>48</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_JIT</td>
- <td>49</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DATA_MASKING</td>
- <td>50</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DATA_CLASSIFICATION</td>
- <td>51</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_SCIM</td>
- <td>52</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DIRECTORY_SYNC</td>
- <td>53</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_TOKEN_DURATION_CONTROL</td>
- <td>54</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_EXTERNAL_SECRET_MANAGER</td>
- <td>55</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_USER_EMAIL_DOMAIN_RESTRICTION</td>
- <td>56</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_PROJECT_MANAGEMENT</td>
- <td>57</td>
- <td><p>Administration &amp; Support</p></td>
- </tr>
-
- <tr>
- <td>FEATURE_ENVIRONMENT_MANAGEMENT</td>
- <td>58</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_IM_NOTIFICATIONS</td>
- <td>59</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_TERRAFORM_PROVIDER</td>
- <td>60</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DATABASE_GROUPS</td>
- <td>61</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_ENVIRONMENT_TIERS</td>
- <td>62</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DASHBOARD_ANNOUNCEMENT</td>
- <td>63</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_API_INTEGRATION_GUIDANCE</td>
- <td>64</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_CUSTOM_LOGO</td>
- <td>65</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_WATERMARK</td>
- <td>66</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_ROADMAP_PRIORITIZATION</td>
- <td>67</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_CUSTOM_MSA</td>
- <td>68</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_COMMUNITY_SUPPORT</td>
- <td>69</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_EMAIL_SUPPORT</td>
- <td>70</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FEATURE_DEDICATED_SUPPORT_WITH_SLA</td>
- <td>71</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+ </tbody>
+ </table>
+
+
+
+
+ <div class="file-heading">
+ <h2 id="v1/subscription_service.proto">v1/subscription_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CancelPurchaseRequest">CancelPurchaseRequest</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>feedback</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Reason the customer is canceling. Maps to Stripe&#39;s cancellation_details.feedback.
+Valid Stripe values: &#34;customer_service&#34;, &#34;low_quality&#34;, &#34;missing_features&#34;,
+&#34;switched_service&#34;, &#34;too_complex&#34;, &#34;too_expensive&#34;, &#34;unused&#34;, &#34;other&#34;.
+Required. </p></td>
+ </tr>
+
+ <tr>
+ <td>comment</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Optional free-form comment. Max 500 chars (Stripe limit). </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.PlanType">PlanType</h3>
+ <h3 id="bytebase.v1.CreatePurchaseRequest">CreatePurchaseRequest</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>PLAN_TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p>Unspecified plan type.</p></td>
- </tr>
-
- <tr>
- <td>FREE</td>
- <td>1</td>
- <td><p>Free plan with basic features and no cost.</p></td>
- </tr>
-
- <tr>
- <td>TEAM</td>
- <td>2</td>
- <td><p>Team plan with collaboration features for small to medium teams.</p></td>
- </tr>
-
- <tr>
- <td>ENTERPRISE</td>
- <td>3</td>
- <td><p>Enterprise plan with advanced features and dedicated support.</p></td>
- </tr>
-
- </tbody>
- </table>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>plan</td>
+ <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>interval</td>
+ <td><a href="#bytebase.v1.BillingInterval">BillingInterval</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>seats</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
- <h3 id="bytebase.v1.PurchaseDiscount.Type">PurchaseDiscount.Type</h3>
+ <h3 id="bytebase.v1.ExportVCSProviderUsersRequest">ExportVCSProviderUsersRequest</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PERCENTAGE_OFF</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FIXED_MONTH_OFF</td>
- <td>2</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>FIXED_PRICE_OFF</td>
- <td>3</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+
+
+
+
- <h3 id="bytebase.v1.PurchasePlanAdditional.Type">PurchasePlanAdditional.Type</h3>
+ <h3 id="bytebase.v1.GetPaymentInfoRequest">GetPaymentInfoRequest</h3>
<p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>TYPE_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>USER</td>
- <td>1</td>
- <td><p></p></td>
- </tr>
-
- </tbody>
- </table>
+
+
+
+
+ <h3 id="bytebase.v1.GetSubscriptionRequest">GetSubscriptionRequest</h3>
+ <p></p>
+
+
+
+ <h3 id="bytebase.v1.ListPurchasePlansRequest">ListPurchasePlansRequest</h3>
+ <p></p>
+
+
+
- <h3 id="bytebase.v1.SubscriptionService">SubscriptionService</h3>
- <p>SubscriptionService manages enterprise subscriptions and licensing.</p>
- <table class="enum-table">
- <thead>
- <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>GetSubscription</td>
- <td><a href="#bytebase.v1.GetSubscriptionRequest">GetSubscriptionRequest</a></td>
- <td><a href="#bytebase.v1.Subscription">Subscription</a></td>
- <td><p>GetSubscription returns the current subscription.
-If there is no license, we will return a free plan subscription without expiration time.
-If there is expired license, we will return a free plan subscription with the expiration time of the expired license.</p></td>
- </tr>
-
- <tr>
- <td>ExportVCSProviderUsers</td>
- <td><a href="#bytebase.v1.ExportVCSProviderUsersRequest">ExportVCSProviderUsersRequest</a></td>
- <td><a href="#google.api.HttpBody">.google.api.HttpBody</a></td>
- <td><p>Exports active VCS users as CSV.</p></td>
- </tr>
-
- <tr>
- <td>UploadLicense</td>
- <td><a href="#bytebase.v1.UploadLicenseRequest">UploadLicenseRequest</a></td>
- <td><a href="#bytebase.v1.Subscription">Subscription</a></td>
- <td><p>Uploads an enterprise license (self-hosted only).</p></td>
- </tr>
-
- <tr>
- <td>CreatePurchase</td>
- <td><a href="#bytebase.v1.CreatePurchaseRequest">CreatePurchaseRequest</a></td>
- <td><a href="#bytebase.v1.PurchaseResponse">PurchaseResponse</a></td>
- <td><p>CreatePurchase creates a new subscription purchase (SaaS only).
-Returns a Stripe Checkout URL for the user to complete payment.</p></td>
- </tr>
-
- <tr>
- <td>UpdatePurchase</td>
- <td><a href="#bytebase.v1.UpdatePurchaseRequest">UpdatePurchaseRequest</a></td>
- <td><a href="#bytebase.v1.PurchaseResponse">PurchaseResponse</a></td>
- <td><p>UpdatePurchase updates an existing subscription (SaaS only).
-May return a Stripe Checkout URL if payment method change is needed.</p></td>
- </tr>
-
- <tr>
- <td>CancelPurchase</td>
- <td><a href="#bytebase.v1.CancelPurchaseRequest">CancelPurchaseRequest</a></td>
- <td><a href="#bytebase.v1.PurchaseResponse">PurchaseResponse</a></td>
- <td><p>CancelPurchase cancels an active subscription (SaaS only).</p></td>
- </tr>
-
- <tr>
- <td>GetPaymentInfo</td>
- <td><a href="#bytebase.v1.GetPaymentInfoRequest">GetPaymentInfoRequest</a></td>
- <td><a href="#bytebase.v1.PaymentInfo">PaymentInfo</a></td>
- <td><p>GetPaymentInfo returns payment details for the current subscription (SaaS only).</p></td>
- </tr>
-
- <tr>
- <td>VerifyCheckoutSession</td>
- <td><a href="#bytebase.v1.VerifyCheckoutSessionRequest">VerifyCheckoutSessionRequest</a></td>
- <td><a href="#bytebase.v1.VerifyCheckoutSessionResponse">VerifyCheckoutSessionResponse</a></td>
- <td><p>VerifyCheckoutSession verifies a Stripe Checkout Session status (SaaS only).</p></td>
- </tr>
-
- <tr>
- <td>ListPurchasePlans</td>
- <td><a href="#bytebase.v1.ListPurchasePlansRequest">ListPurchasePlansRequest</a></td>
- <td><a href="#bytebase.v1.ListPurchasePlansResponse">ListPurchasePlansResponse</a></td>
- <td><p>ListPurchasePlans returns available plans for self-service purchase.</p></td>
- </tr>
-
- </tbody>
- </table>
+ <h3 id="bytebase.v1.ListPurchasePlansResponse">ListPurchasePlansResponse</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>plans</td>
+ <td><a href="#bytebase.v1.PurchasePlan">PurchasePlan</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
-
- <h4>Methods with HTTP bindings</h4>
- <table>
+
+
+
+ <h3 id="bytebase.v1.PaymentInfo">PaymentInfo</h3>
+ <p></p>
+
+
+ <table class="field-table">
<thead>
- <tr>
- <td>Method Name</td>
- <td>Method</td>
- <td>Pattern</td>
- <td>Body</td>
- </tr>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
</thead>
<tbody>
-
-
-
- <tr>
- <td>GetSubscription</td>
- <td>GET</td>
- <td>/v1/subscription</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>ExportVCSProviderUsers</td>
- <td>GET</td>
- <td>/v1/subscription:vcsProviderUsersExport</td>
- <td></td>
- </tr>
-
-
-
-
- <tr>
- <td>UploadLicense</td>
- <td>PATCH</td>
- <td>/v1/subscription/license</td>
- <td>*</td>
- </tr>
-
-
-
- <tr>
- <td>CreatePurchase</td>
- <td>POST</td>
- <td>/v1/subscription:purchase</td>
- <td>*</td>
- </tr>
-
-
+ <tr>
+ <td>total_price</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Total amount paid for the current billing period, in the smallest currency unit (e.g. cents). </p></td>
+ </tr>
+ <tr>
+ <td>currency</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>UpdatePurchase</td>
- <td>POST</td>
- <td>/v1/subscription:updatePurchase</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>period_start</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
+ <tr>
+ <td>period_end</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+ <tr>
+ <td>invoice_url</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Stripe Billing Portal URL for invoice management. </p></td>
+ </tr>
- <tr>
- <td>CancelPurchase</td>
- <td>POST</td>
- <td>/v1/subscription:cancelPurchase</td>
- <td>*</td>
- </tr>
+ <tr>
+ <td>cancel_at_period_end</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether the subscription is scheduled to cancel at the end of the current billing period. </p></td>
+ </tr>
-
+ <tr>
+ <td>next_period_price</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Amount that will be charged at the next renewal, in the smallest currency unit (e.g. cents).
+Empty when the subscription will not renew (e.g. scheduled to cancel at period end). </p></td>
+ </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.PlanConfig">PlanConfig</h3>
+ <p>PlanConfig represents the configuration for all plans loaded from plan.yaml</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
- <tr>
- <td>GetPaymentInfo</td>
- <td>GET</td>
- <td>/v1/subscription/paymentInfo</td>
- <td></td>
- </tr>
+ <tr>
+ <td>plans</td>
+ <td><a href="#bytebase.v1.PlanLimitConfig">PlanLimitConfig</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
-
+ <tr>
+ <td>instance_features</td>
+ <td><a href="#bytebase.v1.PlanFeature">PlanFeature</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.PlanLimitConfig">PlanLimitConfig</h3>
+ <p>PlanLimitConfig represents a single plan's configuration</p>
+
+
+ <table class="field-table">
+ <thead>
+ <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+ </thead>
+ <tbody>
- <tr>
- <td>VerifyCheckoutSession</td>
- <td>GET</td>
- <td>/v1/subscription/checkoutSession/{session_id}</td>
- <td></td>
- </tr>
+ <tr>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
-
+ <tr>
+ <td>maximum_instance_count</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+ <tr>
+ <td>maximum_seat_count</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
- <tr>
- <td>ListPurchasePlans</td>
- <td>GET</td>
- <td>/v1/subscription/plans</td>
- <td></td>
- </tr>
+ <tr>
+ <td>features</td>
+ <td><a href="#bytebase.v1.PlanFeature">PlanFeature</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
-
</tbody>
</table>
+
-
-
-
- <div class="file-heading">
- <h2 id="v1/workload_identity_service.proto">v1/workload_identity_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
+
- <h3 id="bytebase.v1.CreateWorkloadIdentityRequest">CreateWorkloadIdentityRequest</h3>
- <p>Request message for creating a workload identity.</p>
+ <h3 id="bytebase.v1.PurchaseBillingMethod">PurchaseBillingMethod</h3>
+ <p></p>
<table class="field-table">
@@ -33689,27 +33501,17 @@ May return a Stripe Checkout URL if payment method change is needed.</p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent resource where this workload identity will be created.
-Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td>
- </tr>
-
- <tr>
- <td>workload_identity_id</td>
- <td><a href="#string">string</a></td>
+ <td>interval</td>
+ <td><a href="#bytebase.v1.BillingInterval">BillingInterval</a></td>
<td></td>
- <td><p>The ID to use for the workload identity, which will become the final component
-of the workload identity&#39;s email in the format: {workload_identity_id}@workload.bytebase.com
-or {workload_identity_id}@{project-id}.workload.bytebase.com </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>workload_identity</td>
- <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
+ <td>discount</td>
+ <td><a href="#bytebase.v1.PurchaseDiscount">PurchaseDiscount</a></td>
<td></td>
- <td><p>The workload identity to create. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -33719,8 +33521,8 @@ or {workload_identity_id}@{project-id}.workload.bytebase.com </p></td>
- <h3 id="bytebase.v1.DeleteWorkloadIdentityRequest">DeleteWorkloadIdentityRequest</h3>
- <p>Request message for deleting a workload identity.</p>
+ <h3 id="bytebase.v1.PurchaseDiscount">PurchaseDiscount</h3>
+ <p></p>
<table class="field-table">
@@ -33730,11 +33532,17 @@ or {workload_identity_id}@{project-id}.workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PurchaseDiscount.Type">PurchaseDiscount.Type</a></td>
<td></td>
- <td><p>The name of the workload identity to delete.
-Format: workloadIdentities/{email} </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>value</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -33744,8 +33552,8 @@ Format: workloadIdentities/{email} </p></td>
- <h3 id="bytebase.v1.GetWorkloadIdentityRequest">GetWorkloadIdentityRequest</h3>
- <p>Request message for getting a workload identity.</p>
+ <h3 id="bytebase.v1.PurchasePlan">PurchasePlan</h3>
+ <p></p>
<table class="field-table">
@@ -33755,11 +33563,31 @@ Format: workloadIdentities/{email} </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>self_service_purchase</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The name of the workload identity to retrieve.
-Format: workloadIdentities/{email} </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>additionals</td>
+ <td><a href="#bytebase.v1.PurchasePlanAdditional">PurchasePlanAdditional</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>billing_methods</td>
+ <td><a href="#bytebase.v1.PurchaseBillingMethod">PurchaseBillingMethod</a></td>
+ <td>repeated</td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -33769,8 +33597,8 @@ Format: workloadIdentities/{email} </p></td>
- <h3 id="bytebase.v1.ListWorkloadIdentitiesRequest">ListWorkloadIdentitiesRequest</h3>
- <p>Request message for listing workload identities.</p>
+ <h3 id="bytebase.v1.PurchasePlanAdditional">PurchasePlanAdditional</h3>
+ <p></p>
<table class="field-table">
@@ -33780,59 +33608,38 @@ Format: workloadIdentities/{email} </p></td>
<tbody>
<tr>
- <td>parent</td>
- <td><a href="#string">string</a></td>
+ <td>type</td>
+ <td><a href="#bytebase.v1.PurchasePlanAdditional.Type">PurchasePlanAdditional.Type</a></td>
<td></td>
- <td><p>The parent resource.
-Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>page_size</td>
+ <td>unit_price</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The maximum number of workload identities to return. The service may return fewer than
-this value.
-If unspecified, at most 10 workload identities will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
+ <td><p>Price in USD cents per month. </p></td>
</tr>
<tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
+ <td>free_count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListWorkloadIdentities` call.
-Provide this to retrieve the subsequent page.
-
-When paginating, all other parameters provided to `ListWorkloadIdentities` must match
-the call that provided the page token. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>show_deleted</td>
- <td><a href="#bool">bool</a></td>
+ <td>minimum_count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Show deleted workload identities if specified. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
+ <td>maximum_count</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>Filter is used to filter workload identities returned in the list.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- name: the workload identity name, support &#34;==&#34; and &#34;.contains()&#34; operator.
-- email: the workload identity email, support &#34;==&#34; and &#34;.contains()&#34; operator.
-- state: check State enum for values, support &#34;==&#34; operator.
-
-For example:
-name == &#34;ed&#34;
-name.contains(&#34;ed&#34;)
-state == &#34;DELETED&#34;
-email == &#34;[email protected]&#34;
-email.contains(&#34;ed&#34;) </p></td>
+ <td><p>-1 means unlimited. </p></td>
</tr>
</tbody>
@@ -33842,8 +33649,8 @@ email.contains(&#34;ed&#34;) </p></td>
- <h3 id="bytebase.v1.ListWorkloadIdentitiesResponse">ListWorkloadIdentitiesResponse</h3>
- <p>Response message for listing workload identities.</p>
+ <h3 id="bytebase.v1.PurchaseResponse">PurchaseResponse</h3>
+ <p></p>
<table class="field-table">
@@ -33853,18 +33660,18 @@ email.contains(&#34;ed&#34;) </p></td>
<tbody>
<tr>
- <td>workload_identities</td>
- <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
- <td>repeated</td>
- <td><p>The workload identities from the specified request. </p></td>
+ <td>payment_url</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>If set, redirect to this Stripe Checkout URL.
+If empty, the update was applied directly using the existing payment method. </p></td>
</tr>
<tr>
- <td>next_page_token</td>
+ <td>session_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token, which can be sent as `page_token` to retrieve the next page.
-If this field is omitted, there are no subsequent pages. </p></td>
+ <td><p>Stripe Checkout Session ID. Used to verify the session after redirect. </p></td>
</tr>
</tbody>
@@ -33874,8 +33681,8 @@ If this field is omitted, there are no subsequent pages. </p></td>
- <h3 id="bytebase.v1.UndeleteWorkloadIdentityRequest">UndeleteWorkloadIdentityRequest</h3>
- <p>Request message for restoring a deleted workload identity.</p>
+ <h3 id="bytebase.v1.Subscription">Subscription</h3>
+ <p></p>
<table class="field-table">
@@ -33885,46 +33692,66 @@ If this field is omitted, there are no subsequent pages. </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>plan</td>
+ <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
<td></td>
- <td><p>The name of the deleted workload identity.
-Format: workloadIdentities/{email} </p></td>
+ <td><p> </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.UpdateWorkloadIdentityRequest">UpdateWorkloadIdentityRequest</h3>
- <p>Request message for updating a workload identity.</p>
-
-
- <table class="field-table">
- <thead>
- <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
- </thead>
- <tbody>
+ <tr>
+ <td>seats</td>
+ <td><a href="#int32">int32</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
<tr>
- <td>workload_identity</td>
- <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
+ <td>instances</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The workload identity to update.
-
-The workload identity&#39;s `name` field is used to identify the workload identity to update.
-Format: workloadIdentities/{email} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
+ <td>active_instances</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The list of fields to update.
-Supported fields: title, workload_identity_config </p></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>expires_time</td>
+ <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>trialing</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>org_name</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p> </p></td>
+ </tr>
+
+ <tr>
+ <td>ha</td>
+ <td><a href="#bool">bool</a></td>
+ <td></td>
+ <td><p>Whether high availability (multiple replicas) is enabled. </p></td>
+ </tr>
+
+ <tr>
+ <td>etag</td>
+ <td><a href="#string">string</a></td>
+ <td></td>
+ <td><p>Etag for optimistic concurrency on purchase updates. Only set in SaaS mode. </p></td>
</tr>
</tbody>
@@ -33934,8 +33761,8 @@ Supported fields: title, workload_identity_config </p></td>
- <h3 id="bytebase.v1.WorkloadIdentity">WorkloadIdentity</h3>
- <p>WorkloadIdentity represents an external CI/CD workload identity.</p>
+ <h3 id="bytebase.v1.UpdatePurchaseRequest">UpdatePurchaseRequest</h3>
+ <p></p>
<table class="field-table">
@@ -33945,48 +33772,55 @@ Supported fields: title, workload_identity_config </p></td>
<tbody>
<tr>
- <td>name</td>
- <td><a href="#string">string</a></td>
+ <td>plan</td>
+ <td><a href="#bytebase.v1.PlanType">PlanType</a></td>
<td></td>
- <td><p>The name of the workload identity.
-Format: workloadIdentities/{email} </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>state</td>
- <td><a href="#bytebase.v1.State">State</a></td>
+ <td>interval</td>
+ <td><a href="#bytebase.v1.BillingInterval">BillingInterval</a></td>
<td></td>
- <td><p>The state of the workload identity. </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>email</td>
- <td><a href="#string">string</a></td>
+ <td>seats</td>
+ <td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The email of the workload identity.
-For workspace-level: {name}@workload.bytebase.com
-For project-level: {name}@{project-id}.workload.bytebase.com </p></td>
+ <td><p> </p></td>
</tr>
<tr>
- <td>title</td>
+ <td>etag</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The display title of the workload identity. </p></td>
+ <td><p> </p></td>
</tr>
- <tr>
- <td>create_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The timestamp when the workload identity was created. </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.UploadLicenseRequest">UploadLicenseRequest</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>workload_identity_config</td>
- <td><a href="#bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</a></td>
+ <td>license</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The workload identity configuration for OIDC token validation. </p></td>
+ <td><p> </p></td>
</tr>
</tbody>
@@ -33996,8 +33830,8 @@ For project-level: {name}@{project-id}.workload.bytebase.com </p></td>
- <h3 id="bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</h3>
- <p>WorkloadIdentityConfig for API layer</p>
+ <h3 id="bytebase.v1.VerifyCheckoutSessionRequest">VerifyCheckoutSessionRequest</h3>
+ <p></p>
<table class="field-table">
@@ -34007,31 +33841,34 @@ For project-level: {name}@{project-id}.workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>provider_type</td>
- <td><a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</a></td>
- <td></td>
- <td><p>Platform type (currently only GITHUB is supported) </p></td>
- </tr>
-
- <tr>
- <td>issuer_url</td>
+ <td>session_id</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>OIDC Issuer URL (auto-filled based on provider_type, can be overridden) </p></td>
+ <td><p> </p></td>
</tr>
- <tr>
- <td>allowed_audiences</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>Allowed audiences for token validation </p></td>
- </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <h3 id="bytebase.v1.VerifyCheckoutSessionResponse">VerifyCheckoutSessionResponse</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>subject_pattern</td>
+ <td>status</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) </p></td>
+ <td><p>Stripe Checkout Session status: &#34;complete&#34;, &#34;expired&#34;, or &#34;open&#34;. </p></td>
</tr>
</tbody>
@@ -34041,10 +33878,517 @@ For project-level: {name}@{project-id}.workload.bytebase.com </p></td>
-
+
+
+ <h3 id="bytebase.v1.BillingInterval">BillingInterval</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>BILLING_INTERVAL_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>MONTH</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>YEAR</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.PlanFeature">PlanFeature</h3>
+ <p>PlanFeature represents the available features in Bytebase</p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>FEATURE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DATABASE_CHANGE</td>
+ <td>1</td>
+ <td><p>Database Change Management</p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_GIT_BASED_SCHEMA_VERSION_CONTROL</td>
+ <td>2</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DECLARATIVE_SCHEMA_MIGRATION</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_COMPARE_AND_SYNC_SCHEMA</td>
+ <td>4</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_ONLINE_SCHEMA_CHANGE</td>
+ <td>5</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_PRE_DEPLOYMENT_SQL_REVIEW</td>
+ <td>6</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_AUTOMATIC_BACKUP_BEFORE_DATA_CHANGES</td>
+ <td>7</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_ONE_CLICK_DATA_ROLLBACK</td>
+ <td>8</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_MULTI_DATABASE_BATCH_CHANGES</td>
+ <td>9</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_PROGRESSIVE_ENVIRONMENT_DEPLOYMENT</td>
+ <td>10</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_SCHEDULED_ROLLOUT_TIME</td>
+ <td>11</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DATABASE_CHANGELOG</td>
+ <td>12</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_SCHEMA_DRIFT_DETECTION</td>
+ <td>13</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_ROLLOUT_POLICY</td>
+ <td>14</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_WEB_BASED_SQL_EDITOR</td>
+ <td>15</td>
+ <td><p>SQL Editor &amp; Development</p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_SQL_EDITOR_ADMIN_MODE</td>
+ <td>16</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_NATURAL_LANGUAGE_TO_SQL</td>
+ <td>17</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_AI_QUERY_EXPLANATION</td>
+ <td>18</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_AI_QUERY_SUGGESTIONS</td>
+ <td>19</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_AUTO_COMPLETE</td>
+ <td>20</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_SCHEMA_DIAGRAM</td>
+ <td>21</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_SCHEMA_EDITOR</td>
+ <td>22</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DATA_EXPORT</td>
+ <td>23</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DATA_OFFLINE_EXPORT</td>
+ <td>24</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_QUERY_HISTORY</td>
+ <td>25</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_SAVED_AND_SHARED_SQL_SCRIPTS</td>
+ <td>26</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_BATCH_QUERY</td>
+ <td>27</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_INSTANCE_READ_ONLY_CONNECTION</td>
+ <td>28</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_QUERY_POLICY</td>
+ <td>29</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_RESTRICT_COPYING_DATA</td>
+ <td>30</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_IAM</td>
+ <td>31</td>
+ <td><p>Security &amp; Compliance</p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_INSTANCE_SSL_CONNECTION</td>
+ <td>32</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_INSTANCE_CONNECTION_OVER_SSH_TUNNEL</td>
+ <td>33</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_INSTANCE_CONNECTION_IAM_AUTHENTICATION</td>
+ <td>34</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_GOOGLE_AND_GITHUB_SSO</td>
+ <td>35</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_USER_GROUPS</td>
+ <td>36</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DISALLOW_SELF_SERVICE_SIGNUP</td>
+ <td>37</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_CUSTOM_INSTANCE_SYNC_TIME</td>
+ <td>38</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_CUSTOM_INSTANCE_CONNECTION_LIMIT</td>
+ <td>39</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_RISK_ASSESSMENT</td>
+ <td>40</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_APPROVAL_WORKFLOW</td>
+ <td>41</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_AUDIT_LOG</td>
+ <td>42</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_ENTERPRISE_SSO</td>
+ <td>43</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_TWO_FA</td>
+ <td>44</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_PASSWORD_RESTRICTIONS</td>
+ <td>45</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DISALLOW_PASSWORD_SIGNIN</td>
+ <td>46</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_CUSTOM_ROLES</td>
+ <td>47</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_REQUEST_ROLE_WORKFLOW</td>
+ <td>48</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_JIT</td>
+ <td>49</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DATA_MASKING</td>
+ <td>50</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DATA_CLASSIFICATION</td>
+ <td>51</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_SCIM</td>
+ <td>52</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DIRECTORY_SYNC</td>
+ <td>53</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_TOKEN_DURATION_CONTROL</td>
+ <td>54</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_EXTERNAL_SECRET_MANAGER</td>
+ <td>55</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_USER_EMAIL_DOMAIN_RESTRICTION</td>
+ <td>56</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_PROJECT_MANAGEMENT</td>
+ <td>57</td>
+ <td><p>Administration &amp; Support</p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_ENVIRONMENT_MANAGEMENT</td>
+ <td>58</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_IM_NOTIFICATIONS</td>
+ <td>59</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_TERRAFORM_PROVIDER</td>
+ <td>60</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DATABASE_GROUPS</td>
+ <td>61</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_ENVIRONMENT_TIERS</td>
+ <td>62</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DASHBOARD_ANNOUNCEMENT</td>
+ <td>63</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_API_INTEGRATION_GUIDANCE</td>
+ <td>64</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_CUSTOM_LOGO</td>
+ <td>65</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_WATERMARK</td>
+ <td>66</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_ROADMAP_PRIORITIZATION</td>
+ <td>67</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_CUSTOM_MSA</td>
+ <td>68</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_COMMUNITY_SUPPORT</td>
+ <td>69</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_EMAIL_SUPPORT</td>
+ <td>70</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>FEATURE_DEDICATED_SUPPORT_WITH_SLA</td>
+ <td>71</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.PlanType">PlanType</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>PLAN_TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p>Unspecified plan type.</p></td>
+ </tr>
+
+ <tr>
+ <td>FREE</td>
+ <td>1</td>
+ <td><p>Free plan with basic features and no cost.</p></td>
+ </tr>
+
+ <tr>
+ <td>TEAM</td>
+ <td>2</td>
+ <td><p>Team plan with collaboration features for small to medium teams.</p></td>
+ </tr>
+
+ <tr>
+ <td>ENTERPRISE</td>
+ <td>3</td>
+ <td><p>Enterprise plan with advanced features and dedicated support.</p></td>
+ </tr>
+
+ </tbody>
+ </table>
- <h3 id="bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</h3>
- <p>ProviderType identifies the CI/CD platform.</p>
+ <h3 id="bytebase.v1.PurchaseDiscount.Type">PurchaseDiscount.Type</h3>
+ <p></p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -34052,23 +34396,52 @@ For project-level: {name}@{project-id}.workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>PROVIDER_TYPE_UNSPECIFIED</td>
+ <td>TYPE_UNSPECIFIED</td>
<td>0</td>
<td><p></p></td>
</tr>
<tr>
- <td>GITHUB</td>
+ <td>PERCENTAGE_OFF</td>
<td>1</td>
<td><p></p></td>
</tr>
<tr>
- <td>GITLAB</td>
+ <td>FIXED_MONTH_OFF</td>
<td>2</td>
<td><p></p></td>
</tr>
+ <tr>
+ <td>FIXED_PRICE_OFF</td>
+ <td>3</td>
+ <td><p></p></td>
+ </tr>
+
+ </tbody>
+ </table>
+
+ <h3 id="bytebase.v1.PurchasePlanAdditional.Type">PurchasePlanAdditional.Type</h3>
+ <p></p>
+ <table class="enum-table">
+ <thead>
+ <tr><td>Name</td><td>Number</td><td>Description</td></tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td>TYPE_UNSPECIFIED</td>
+ <td>0</td>
+ <td><p></p></td>
+ </tr>
+
+ <tr>
+ <td>USER</td>
+ <td>1</td>
+ <td><p></p></td>
+ </tr>
+
</tbody>
</table>
@@ -34076,8 +34449,8 @@ For project-level: {name}@{project-id}.workload.bytebase.com </p></td>
- <h3 id="bytebase.v1.WorkloadIdentityService">WorkloadIdentityService</h3>
- <p>WorkloadIdentityService manages workload identities for external CI/CD integrations.</p>
+ <h3 id="bytebase.v1.SubscriptionService">SubscriptionService</h3>
+ <p>SubscriptionService manages enterprise subscriptions and licensing.</p>
<table class="enum-table">
<thead>
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
@@ -34085,53 +34458,70 @@ For project-level: {name}@{project-id}.workload.bytebase.com </p></td>
<tbody>
<tr>
- <td>CreateWorkloadIdentity</td>
- <td><a href="#bytebase.v1.CreateWorkloadIdentityRequest">CreateWorkloadIdentityRequest</a></td>
- <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
- <td><p>Creates a new workload identity.
-For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.create on workspace.
-For project-level: parent is projects/{project}, permission bb.workloadIdentities.create on project.</p></td>
+ <td>GetSubscription</td>
+ <td><a href="#bytebase.v1.GetSubscriptionRequest">GetSubscriptionRequest</a></td>
+ <td><a href="#bytebase.v1.Subscription">Subscription</a></td>
+ <td><p>GetSubscription returns the current subscription.
+If there is no license, we will return a free plan subscription without expiration time.
+If there is expired license, we will return a free plan subscription with the expiration time of the expired license.</p></td>
</tr>
<tr>
- <td>GetWorkloadIdentity</td>
- <td><a href="#bytebase.v1.GetWorkloadIdentityRequest">GetWorkloadIdentityRequest</a></td>
- <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
- <td><p>Gets a workload identity by name.
-Permissions required: bb.workloadIdentities.get</p></td>
+ <td>ExportVCSProviderUsers</td>
+ <td><a href="#bytebase.v1.ExportVCSProviderUsersRequest">ExportVCSProviderUsersRequest</a></td>
+ <td><a href="#google.api.HttpBody">.google.api.HttpBody</a></td>
+ <td><p>Exports active VCS users as CSV.</p></td>
</tr>
<tr>
- <td>ListWorkloadIdentities</td>
- <td><a href="#bytebase.v1.ListWorkloadIdentitiesRequest">ListWorkloadIdentitiesRequest</a></td>
- <td><a href="#bytebase.v1.ListWorkloadIdentitiesResponse">ListWorkloadIdentitiesResponse</a></td>
- <td><p>Lists workload identities.
-For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.list on workspace.
-For project-level: parent is projects/{project}, permission bb.workloadIdentities.list on project.</p></td>
+ <td>UploadLicense</td>
+ <td><a href="#bytebase.v1.UploadLicenseRequest">UploadLicenseRequest</a></td>
+ <td><a href="#bytebase.v1.Subscription">Subscription</a></td>
+ <td><p>Uploads an enterprise license (self-hosted only).</p></td>
</tr>
<tr>
- <td>UpdateWorkloadIdentity</td>
- <td><a href="#bytebase.v1.UpdateWorkloadIdentityRequest">UpdateWorkloadIdentityRequest</a></td>
- <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
- <td><p>Updates a workload identity.
-Permissions required: bb.workloadIdentities.update</p></td>
+ <td>CreatePurchase</td>
+ <td><a href="#bytebase.v1.CreatePurchaseRequest">CreatePurchaseRequest</a></td>
+ <td><a href="#bytebase.v1.PurchaseResponse">PurchaseResponse</a></td>
+ <td><p>CreatePurchase creates a new subscription purchase (SaaS only).
+Returns a Stripe Checkout URL for the user to complete payment.</p></td>
</tr>
<tr>
- <td>DeleteWorkloadIdentity</td>
- <td><a href="#bytebase.v1.DeleteWorkloadIdentityRequest">DeleteWorkloadIdentityRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Deletes a workload identity.
-Permissions required: bb.workloadIdentities.delete</p></td>
+ <td>UpdatePurchase</td>
+ <td><a href="#bytebase.v1.UpdatePurchaseRequest">UpdatePurchaseRequest</a></td>
+ <td><a href="#bytebase.v1.PurchaseResponse">PurchaseResponse</a></td>
+ <td><p>UpdatePurchase updates an existing subscription (SaaS only).
+May return a Stripe Checkout URL if payment method change is needed.</p></td>
</tr>
<tr>
- <td>UndeleteWorkloadIdentity</td>
- <td><a href="#bytebase.v1.UndeleteWorkloadIdentityRequest">UndeleteWorkloadIdentityRequest</a></td>
- <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
- <td><p>Restores a deleted workload identity.
-Permissions required: bb.workloadIdentities.undelete</p></td>
+ <td>CancelPurchase</td>
+ <td><a href="#bytebase.v1.CancelPurchaseRequest">CancelPurchaseRequest</a></td>
+ <td><a href="#bytebase.v1.PurchaseResponse">PurchaseResponse</a></td>
+ <td><p>CancelPurchase cancels an active subscription (SaaS only).</p></td>
+ </tr>
+
+ <tr>
+ <td>GetPaymentInfo</td>
+ <td><a href="#bytebase.v1.GetPaymentInfoRequest">GetPaymentInfoRequest</a></td>
+ <td><a href="#bytebase.v1.PaymentInfo">PaymentInfo</a></td>
+ <td><p>GetPaymentInfo returns payment details for the current subscription (SaaS only).</p></td>
+ </tr>
+
+ <tr>
+ <td>VerifyCheckoutSession</td>
+ <td><a href="#bytebase.v1.VerifyCheckoutSessionRequest">VerifyCheckoutSessionRequest</a></td>
+ <td><a href="#bytebase.v1.VerifyCheckoutSessionResponse">VerifyCheckoutSessionResponse</a></td>
+ <td><p>VerifyCheckoutSession verifies a Stripe Checkout Session status (SaaS only).</p></td>
+ </tr>
+
+ <tr>
+ <td>ListPurchasePlans</td>
+ <td><a href="#bytebase.v1.ListPurchasePlansRequest">ListPurchasePlansRequest</a></td>
+ <td><a href="#bytebase.v1.ListPurchasePlansResponse">ListPurchasePlansResponse</a></td>
+ <td><p>ListPurchasePlans returns available plans for self-service purchase.</p></td>
</tr>
</tbody>
@@ -34155,26 +34545,19 @@ Permissions required: bb.workloadIdentities.undelete</p></td>
<tr>
- <td>CreateWorkloadIdentity</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/workloadIdentities</td>
- <td>workload_identity</td>
- </tr>
-
- <tr>
- <td>CreateWorkloadIdentity</td>
- <td>POST</td>
- <td>/v1/{parent=workspaces/*}/workloadIdentities</td>
- <td>workload_identity</td>
+ <td>GetSubscription</td>
+ <td>GET</td>
+ <td>/v1/subscription</td>
+ <td></td>
</tr>
<tr>
- <td>GetWorkloadIdentity</td>
+ <td>ExportVCSProviderUsers</td>
<td>GET</td>
- <td>/v1/{name=workloadIdentities/*}</td>
+ <td>/v1/subscription:vcsProviderUsersExport</td>
<td></td>
</tr>
@@ -34182,153 +34565,87 @@ Permissions required: bb.workloadIdentities.undelete</p></td>
<tr>
- <td>ListWorkloadIdentities</td>
- <td>GET</td>
- <td>/v1/{parent=projects/*}/workloadIdentities</td>
- <td></td>
- </tr>
-
- <tr>
- <td>ListWorkloadIdentities</td>
- <td>GET</td>
- <td>/v1/{parent=workspaces/*}/workloadIdentities</td>
- <td></td>
+ <td>UploadLicense</td>
+ <td>PATCH</td>
+ <td>/v1/subscription/license</td>
+ <td>*</td>
</tr>
<tr>
- <td>UpdateWorkloadIdentity</td>
- <td>PATCH</td>
- <td>/v1/{workload_identity.name=workloadIdentities/*}</td>
- <td>workload_identity</td>
+ <td>CreatePurchase</td>
+ <td>POST</td>
+ <td>/v1/subscription:purchase</td>
+ <td>*</td>
</tr>
<tr>
- <td>DeleteWorkloadIdentity</td>
- <td>DELETE</td>
- <td>/v1/{name=workloadIdentities/*}</td>
- <td></td>
+ <td>UpdatePurchase</td>
+ <td>POST</td>
+ <td>/v1/subscription:updatePurchase</td>
+ <td>*</td>
</tr>
<tr>
- <td>UndeleteWorkloadIdentity</td>
+ <td>CancelPurchase</td>
<td>POST</td>
- <td>/v1/{name=workloadIdentities/*}:undelete</td>
+ <td>/v1/subscription:cancelPurchase</td>
<td>*</td>
</tr>
- </tbody>
- </table>
-
-
-
-
- <div class="file-heading">
- <h2 id="v1/worksheet_service.proto">v1/worksheet_service.proto</h2><a href="#title">Top</a>
- </div>
- <p></p>
-
-
- <h3 id="bytebase.v1.BatchUpdateWorksheetOrganizerRequest">BatchUpdateWorksheetOrganizerRequest</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>parent</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The parent resource whose worksheets&#39; organizers are updated.
-Format: projects/{project} </p></td>
- </tr>
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>To filter the batch update target.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- name: the worksheet name in &#34;projects/{project}/worksheets/{worksheet}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator.
-- creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
-- starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred sheets, support &#34;==&#34; operator.
-- visibility: check Visibility enum in the Worksheet message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator.
-- folder: the worksheet organizer folder path, support exact &#34;==&#34; operator. </p></td>
- </tr>
+ <tr>
+ <td>GetPaymentInfo</td>
+ <td>GET</td>
+ <td>/v1/subscription/paymentInfo</td>
+ <td></td>
+ </tr>
- <tr>
- <td>organizer</td>
- <td><a href="#bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</a></td>
- <td></td>
- <td><p>The organizer fields to update. </p></td>
- </tr>
+
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></td>
- <td><p>The list of fields to be updated.
-Fields are specified relative to the worksheet organizer.
-Only support update the following fields for now:
-- `starred`
-- `folders` </p></td>
- </tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.BatchUpdateWorksheetOrganizerResponse">BatchUpdateWorksheetOrganizerResponse</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>VerifyCheckoutSession</td>
+ <td>GET</td>
+ <td>/v1/subscription/checkoutSession/{session_id}</td>
+ <td></td>
+ </tr>
+
+
- <tr>
- <td>worksheet_organizers</td>
- <td><a href="#bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</a></td>
- <td>repeated</td>
- <td><p> </p></td>
- </tr>
- <tr>
- <td>updated_count</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p> </p></td>
- </tr>
+ <tr>
+ <td>ListPurchasePlans</td>
+ <td>GET</td>
+ <td>/v1/subscription/plans</td>
+ <td></td>
+ </tr>
+
</tbody>
</table>
-
-
+
- <h3 id="bytebase.v1.CreateWorksheetRequest">CreateWorksheetRequest</h3>
- <p></p>
+ <div class="file-heading">
+ <h2 id="v1/workload_identity_service.proto">v1/workload_identity_service.proto</h2><a href="#title">Top</a>
+ </div>
+ <p></p>
+
+
+ <h3 id="bytebase.v1.CreateWorkloadIdentityRequest">CreateWorkloadIdentityRequest</h3>
+ <p>Request message for creating a workload identity.</p>
<table class="field-table">
@@ -34341,40 +34658,24 @@ Only support update the following fields for now:
<td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource where this worksheet will be created.
-Format: projects/{project} </p></td>
+ <td><p>The parent resource where this workload identity will be created.
+Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td>
</tr>
<tr>
- <td>worksheet</td>
- <td><a href="#bytebase.v1.Worksheet">Worksheet</a></td>
+ <td>workload_identity_id</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>The worksheet to create. </p></td>
+ <td><p>The ID to use for the workload identity, which will become the final component
+of the workload identity&#39;s email in the format: {workload_identity_id}@workload.bytebase.com
+or {workload_identity_id}@{project-id}.workload.bytebase.com </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.DeleteWorksheetRequest">DeleteWorksheetRequest</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>name</td>
- <td><a href="#string">string</a></td>
+ <td>workload_identity</td>
+ <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
<td></td>
- <td><p>The name of the worksheet to delete.
-Format: projects/{project}/worksheets/{worksheet} </p></td>
+ <td><p>The workload identity to create. </p></td>
</tr>
</tbody>
@@ -34384,8 +34685,8 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
- <h3 id="bytebase.v1.GetWorksheetRequest">GetWorksheetRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.DeleteWorkloadIdentityRequest">DeleteWorkloadIdentityRequest</h3>
+ <p>Request message for deleting a workload identity.</p>
<table class="field-table">
@@ -34398,8 +34699,8 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the worksheet to retrieve.
-Format: projects/{project}/worksheets/{worksheet} </p></td>
+ <td><p>The name of the workload identity to delete.
+Format: workloadIdentities/{email} </p></td>
</tr>
</tbody>
@@ -34409,8 +34710,8 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
- <h3 id="bytebase.v1.ListWorksheetFoldersRequest">ListWorksheetFoldersRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.GetWorkloadIdentityRequest">GetWorkloadIdentityRequest</h3>
+ <p>Request message for getting a workload identity.</p>
<table class="field-table">
@@ -34420,35 +34721,11 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
<tbody>
<tr>
- <td>parent</td>
+ <td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource of the worksheet folders.
-Format: projects/{project} </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListWorksheetFoldersResponse">ListWorksheetFoldersResponse</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>folders</td>
- <td><a href="#bytebase.v1.WorksheetFolder">WorksheetFolder</a></td>
- <td>repeated</td>
- <td><p>The caller&#39;s worksheet folders. </p></td>
+ <td><p>The name of the workload identity to retrieve.
+Format: workloadIdentities/{email} </p></td>
</tr>
</tbody>
@@ -34458,8 +34735,8 @@ Format: projects/{project} </p></td>
- <h3 id="bytebase.v1.ListWorksheetsRequest">ListWorksheetsRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListWorkloadIdentitiesRequest">ListWorkloadIdentitiesRequest</h3>
+ <p>Request message for listing workload identities.</p>
<table class="field-table">
@@ -34472,33 +34749,17 @@ Format: projects/{project} </p></td>
<td>parent</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The parent resource of the worksheets.
-Format: projects/{project}
-Use &#34;projects/-&#34; to list worksheets across all projects. </p></td>
- </tr>
-
- <tr>
- <td>filter</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>To filter the list result.
-The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
-
-Supported filter:
-- creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
-
-For example:
-creator == &#34;users/{email}&#34;
-creator != &#34;users/{email}&#34; </p></td>
+ <td><p>The parent resource.
+Format: projects/{project} for project-level, workspaces/{id} for workspace-level. </p></td>
</tr>
<tr>
<td>page_size</td>
<td><a href="#int32">int32</a></td>
<td></td>
- <td><p>The maximum number of worksheets to return. The service may return fewer than
+ <td><p>The maximum number of workload identities to return. The service may return fewer than
this value.
-If unspecified, at most 10 worksheets will be returned.
+If unspecified, at most 10 workload identities will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
</tr>
@@ -34506,113 +34767,38 @@ The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
<td>page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A page token, received from a previous `ListWorksheets` call.
+ <td><p>A page token, received from a previous `ListWorkloadIdentities` call.
Provide this to retrieve the subsequent page.
-When paginating, all other parameters provided to `ListWorksheets` must match
+When paginating, all other parameters provided to `ListWorkloadIdentities` must match
the call that provided the page token. </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.ListWorksheetsResponse">ListWorksheetsResponse</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>worksheets</td>
- <td><a href="#bytebase.v1.Worksheet">Worksheet</a></td>
- <td>repeated</td>
- <td><p>The worksheets from the specified parent. </p></td>
- </tr>
-
- <tr>
- <td>next_page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A token to retrieve next page of worksheets.
-Pass this value in the page_token field in the subsequent call to
-`ListWorksheets` method to retrieve the next page of worksheets. </p></td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.SearchWorksheetsRequest">SearchWorksheetsRequest</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>parent</td>
- <td><a href="#string">string</a></td>
+ <td>show_deleted</td>
+ <td><a href="#bool">bool</a></td>
<td></td>
- <td><p>The parent resource of the worksheets.
-Format: projects/{project} </p></td>
+ <td><p>Show deleted workload identities if specified. </p></td>
</tr>
<tr>
<td>filter</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>To filter the search result.
+ <td><p>Filter is used to filter workload identities returned in the list.
The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
Supported filter:
-- name: the worksheet name in &#34;projects/{project}/worksheets/{worksheet}&#34; format, support &#34;==&#34; and &#34;in [xx]&#34; operator.
-- title: the worksheet title, support &#34;contains&#34; operator.
-- creator: the worksheet creator in &#34;users/{email}&#34; format, support &#34;==&#34; and &#34;!=&#34; operator.
-- starred: should be &#34;true&#34; or &#34;false&#34;, filter starred/unstarred sheets, support &#34;==&#34; operator.
-- visibility: check Visibility enum in the Worksheet message for values, support &#34;==&#34; and &#34;in [xx]&#34; operator.
-- folder: the worksheet organizer folder path, support &#34;==&#34; operator.
+- name: the workload identity name, support &#34;==&#34; and &#34;.contains()&#34; operator.
+- email: the workload identity email, support &#34;==&#34; and &#34;.contains()&#34; operator.
+- state: check State enum for values, support &#34;==&#34; operator.
For example:
-creator == &#34;users/{email}&#34;
-title.contains(&#34;worksheet title&#34;)
-creator != &#34;users/{email}&#34;
-starred == true
-starred == false
-visibility in [&#34;PRIVATE&#34;, &#34;PROJECT_READ&#34;, &#34;PROJECT_WRITE&#34;]
-visibility == &#34;PRIVATE&#34;
-folder == &#34;foo/bar&#34; </p></td>
- </tr>
-
- <tr>
- <td>page_size</td>
- <td><a href="#int32">int32</a></td>
- <td></td>
- <td><p>The maximum number of worksheets to return. The service may return fewer than
-this value.
-If unspecified, at most 10 worksheets will be returned.
-The maximum value is 1000; values above 1000 will be coerced to 1000. </p></td>
- </tr>
-
- <tr>
- <td>page_token</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>A page token, received from a previous `SearchWorksheets` call.
-Provide this to retrieve the subsequent page. </p></td>
+name == &#34;ed&#34;
+name.contains(&#34;ed&#34;)
+state == &#34;DELETED&#34;
+email == &#34;[email protected]&#34;
+email.contains(&#34;ed&#34;) </p></td>
</tr>
</tbody>
@@ -34622,8 +34808,8 @@ Provide this to retrieve the subsequent page. </p></td>
- <h3 id="bytebase.v1.SearchWorksheetsResponse">SearchWorksheetsResponse</h3>
- <p></p>
+ <h3 id="bytebase.v1.ListWorkloadIdentitiesResponse">ListWorkloadIdentitiesResponse</h3>
+ <p>Response message for listing workload identities.</p>
<table class="field-table">
@@ -34633,19 +34819,18 @@ Provide this to retrieve the subsequent page. </p></td>
<tbody>
<tr>
- <td>worksheets</td>
- <td><a href="#bytebase.v1.Worksheet">Worksheet</a></td>
+ <td>workload_identities</td>
+ <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
<td>repeated</td>
- <td><p>The worksheets that matched the search criteria. </p></td>
+ <td><p>The workload identities from the specified request. </p></td>
</tr>
<tr>
<td>next_page_token</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>A token to retrieve next page of worksheets.
-Pass this value in the page_token field in the subsequent call to
-`SearchWorksheets` method to retrieve the next page of worksheets. </p></td>
+ <td><p>A token, which can be sent as `page_token` to retrieve the next page.
+If this field is omitted, there are no subsequent pages. </p></td>
</tr>
</tbody>
@@ -34655,8 +34840,8 @@ Pass this value in the page_token field in the subsequent call to
- <h3 id="bytebase.v1.UpdateWorksheetOrganizerRequest">UpdateWorksheetOrganizerRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.UndeleteWorkloadIdentityRequest">UndeleteWorkloadIdentityRequest</h3>
+ <p>Request message for restoring a deleted workload identity.</p>
<table class="field-table">
@@ -34666,31 +34851,11 @@ Pass this value in the page_token field in the subsequent call to
<tbody>
<tr>
- <td>organizer</td>
- <td><a href="#bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</a></td>
- <td></td>
- <td><p>The organizer to update.
-
-The organizer&#39;s `worksheet` field is used to identify the worksheet.
-Format: projects/{project}/worksheets/{worksheet} </p></td>
- </tr>
-
- <tr>
- <td>update_mask</td>
- <td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
- <td></td>
- <td><p>The list of fields to be updated.
-Fields are specified relative to the worksheet organizer.
-Only support update the following fields for now:
-- `starred` </p></td>
- </tr>
-
- <tr>
- <td>allow_missing</td>
- <td><a href="#bool">bool</a></td>
+ <td>name</td>
+ <td><a href="#string">string</a></td>
<td></td>
- <td><p>If set to true, and the worksheet organizer is not found, a new worksheet organizer will be created.
-In this situation, `update_mask` is ignored. </p></td>
+ <td><p>The name of the deleted workload identity.
+Format: workloadIdentities/{email} </p></td>
</tr>
</tbody>
@@ -34700,8 +34865,8 @@ In this situation, `update_mask` is ignored. </p></td>
- <h3 id="bytebase.v1.UpdateWorksheetRequest">UpdateWorksheetRequest</h3>
- <p></p>
+ <h3 id="bytebase.v1.UpdateWorkloadIdentityRequest">UpdateWorkloadIdentityRequest</h3>
+ <p>Request message for updating a workload identity.</p>
<table class="field-table">
@@ -34711,27 +34876,21 @@ In this situation, `update_mask` is ignored. </p></td>
<tbody>
<tr>
- <td>worksheet</td>
- <td><a href="#bytebase.v1.Worksheet">Worksheet</a></td>
+ <td>workload_identity</td>
+ <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
<td></td>
- <td><p>The worksheet to update.
+ <td><p>The workload identity to update.
-The worksheet&#39;s `name` field is used to identify the worksheet to update.
-Format: projects/{project}/worksheets/{worksheet} </p></td>
+The workload identity&#39;s `name` field is used to identify the workload identity to update.
+Format: workloadIdentities/{email} </p></td>
</tr>
<tr>
<td>update_mask</td>
<td><a href="#google.protobuf.FieldMask">google.protobuf.FieldMask</a></td>
<td></td>
- <td><p>The list of fields to be updated.
-Fields are specified relative to the worksheet.
-(e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)
-Only support update the following fields for now:
-- `title`
-- `statement`
-- `starred`
-- `visibility` </p></td>
+ <td><p>The list of fields to update.
+Supported fields: title, workload_identity_config </p></td>
</tr>
</tbody>
@@ -34741,8 +34900,8 @@ Only support update the following fields for now:
- <h3 id="bytebase.v1.Worksheet">Worksheet</h3>
- <p></p>
+ <h3 id="bytebase.v1.WorkloadIdentity">WorkloadIdentity</h3>
+ <p>WorkloadIdentity represents an external CI/CD workload identity.</p>
<table class="field-table">
@@ -34755,92 +34914,45 @@ Only support update the following fields for now:
<td>name</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the worksheet resource, generated by the server.
-Canonical parent is project.
-Format: projects/{project}/worksheets/{worksheet} </p></td>
+ <td><p>The name of the workload identity.
+Format: workloadIdentities/{email} </p></td>
</tr>
<tr>
- <td>project</td>
- <td><a href="#string">string</a></td>
+ <td>state</td>
+ <td><a href="#bytebase.v1.State">State</a></td>
<td></td>
- <td><p>The project resource name.
-Format: projects/{project} </p></td>
+ <td><p>The state of the workload identity. </p></td>
</tr>
<tr>
- <td>database</td>
+ <td>email</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The database resource name.
-Format: instances/{instance}/databases/{database}
-If the database parent doesn&#39;t exist, the database field is empty. </p></td>
+ <td><p>The email of the workload identity.
+For workspace-level: {name}@workload.bytebase.com
+For project-level: {name}@{project-id}.workload.bytebase.com </p></td>
</tr>
<tr>
<td>title</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The title of the worksheet. </p></td>
- </tr>
-
- <tr>
- <td>creator</td>
- <td><a href="#string">string</a></td>
- <td></td>
- <td><p>The creator of the Worksheet.
-Format: users/{email} </p></td>
+ <td><p>The display title of the workload identity. </p></td>
</tr>
<tr>
<td>create_time</td>
<td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
<td></td>
- <td><p>The create time of the worksheet. </p></td>
- </tr>
-
- <tr>
- <td>update_time</td>
- <td><a href="#google.protobuf.Timestamp">google.protobuf.Timestamp</a></td>
- <td></td>
- <td><p>The last update time of the worksheet. </p></td>
- </tr>
-
- <tr>
- <td>content</td>
- <td><a href="#bytes">bytes</a></td>
- <td></td>
- <td><p>The content of the worksheet.
-By default, it will be cut off in SearchWorksheet() method. If it doesn&#39;t match the `content_size`, you can
-use GetWorksheet() request to retrieve the full content. </p></td>
- </tr>
-
- <tr>
- <td>content_size</td>
- <td><a href="#int64">int64</a></td>
- <td></td>
- <td><p>content_size is the full size of the content, may not match the size of the `content` field. </p></td>
- </tr>
-
- <tr>
- <td>visibility</td>
- <td><a href="#bytebase.v1.Worksheet.Visibility">Worksheet.Visibility</a></td>
- <td></td>
- <td><p> </p></td>
+ <td><p>The timestamp when the workload identity was created. </p></td>
</tr>
<tr>
- <td>starred</td>
- <td><a href="#bool">bool</a></td>
+ <td>workload_identity_config</td>
+ <td><a href="#bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</a></td>
<td></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>
+ <td><p>The workload identity configuration for OIDC token validation. </p></td>
</tr>
</tbody>
@@ -34850,8 +34962,8 @@ use GetWorksheet() request to retrieve the full content. </p></td>
- <h3 id="bytebase.v1.WorksheetFolder">WorksheetFolder</h3>
- <p></p>
+ <h3 id="bytebase.v1.WorkloadIdentityConfig">WorkloadIdentityConfig</h3>
+ <p>WorkloadIdentityConfig for API layer</p>
<table class="field-table">
@@ -34861,56 +34973,31 @@ use GetWorksheet() request to retrieve the full content. </p></td>
<tbody>
<tr>
- <td>folders</td>
- <td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p>The folder path segments. </p></td>
- </tr>
-
- <tr>
- <td>category</td>
- <td><a href="#bytebase.v1.WorksheetFolder.Category">WorksheetFolder.Category</a></td>
+ <td>provider_type</td>
+ <td><a href="#bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</a></td>
<td></td>
- <td><p>The folder category. </p></td>
+ <td><p>Platform type (currently only GITHUB is supported) </p></td>
</tr>
- </tbody>
- </table>
-
-
-
-
-
- <h3 id="bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</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>worksheet</td>
+ <td>issuer_url</td>
<td><a href="#string">string</a></td>
<td></td>
- <td><p>The name of the worksheet.
-Format: projects/{project}/worksheets/{worksheet} </p></td>
+ <td><p>OIDC Issuer URL (auto-filled based on provider_type, can be overridden) </p></td>
</tr>
<tr>
- <td>starred</td>
- <td><a href="#bool">bool</a></td>
- <td></td>
- <td><p>starred means if the worksheet is starred. </p></td>
+ <td>allowed_audiences</td>
+ <td><a href="#string">string</a></td>
+ <td>repeated</td>
+ <td><p>Allowed audiences for token validation </p></td>
</tr>
<tr>
- <td>folders</td>
+ <td>subject_pattern</td>
<td><a href="#string">string</a></td>
- <td>repeated</td>
- <td><p> </p></td>
+ <td></td>
+ <td><p>Subject pattern to match (e.g., &#34;repo:owner/repo:ref:refs/heads/main&#34;) </p></td>
</tr>
</tbody>
@@ -34922,43 +35009,8 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
- <h3 id="bytebase.v1.Worksheet.Visibility">Worksheet.Visibility</h3>
- <p></p>
- <table class="enum-table">
- <thead>
- <tr><td>Name</td><td>Number</td><td>Description</td></tr>
- </thead>
- <tbody>
-
- <tr>
- <td>VISIBILITY_UNSPECIFIED</td>
- <td>0</td>
- <td><p></p></td>
- </tr>
-
- <tr>
- <td>PROJECT_READ</td>
- <td>1</td>
- <td><p>Read access in project scope, worksheet OWNER/DBA and project OWNER can read/write, other project members can read.</p></td>
- </tr>
-
- <tr>
- <td>PROJECT_WRITE</td>
- <td>2</td>
- <td><p>Write access in project scope, worksheet OWNER/DBA and all members in the project can write the worksheet.</p></td>
- </tr>
-
- <tr>
- <td>PRIVATE</td>
- <td>3</td>
- <td><p>Private, only worksheet OWNER can read/write.</p></td>
- </tr>
-
- </tbody>
- </table>
-
- <h3 id="bytebase.v1.WorksheetFolder.Category">WorksheetFolder.Category</h3>
- <p></p>
+ <h3 id="bytebase.v1.WorkloadIdentityConfig.ProviderType">WorkloadIdentityConfig.ProviderType</h3>
+ <p>ProviderType identifies the CI/CD platform.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -34966,19 +35018,19 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
<tbody>
<tr>
- <td>CATEGORY_UNSPECIFIED</td>
+ <td>PROVIDER_TYPE_UNSPECIFIED</td>
<td>0</td>
<td><p></p></td>
</tr>
<tr>
- <td>MINE</td>
+ <td>GITHUB</td>
<td>1</td>
<td><p></p></td>
</tr>
<tr>
- <td>SHARED</td>
+ <td>GITLAB</td>
<td>2</td>
<td><p></p></td>
</tr>
@@ -34990,8 +35042,8 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
- <h3 id="bytebase.v1.WorksheetService">WorksheetService</h3>
- <p>WorksheetService manages SQL worksheets for query development.</p>
+ <h3 id="bytebase.v1.WorkloadIdentityService">WorkloadIdentityService</h3>
+ <p>WorkloadIdentityService manages workload identities for external CI/CD integrations.</p>
<table class="enum-table">
<thead>
<tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr>
@@ -34999,89 +35051,53 @@ Format: projects/{project}/worksheets/{worksheet} </p></td>
<tbody>
<tr>
- <td>CreateWorksheet</td>
- <td><a href="#bytebase.v1.CreateWorksheetRequest">CreateWorksheetRequest</a></td>
- <td><a href="#bytebase.v1.Worksheet">Worksheet</a></td>
- <td><p>Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
-Permissions required: None (authenticated users only)</p></td>
- </tr>
-
- <tr>
- <td>GetWorksheet</td>
- <td><a href="#bytebase.v1.GetWorksheetRequest">GetWorksheetRequest</a></td>
- <td><a href="#bytebase.v1.Worksheet">Worksheet</a></td>
- <td><p>Get a worksheet by name.
-The users can access this method if,
-- they are the creator of the worksheet;
-- they have bb.worksheets.get permission on the workspace;
-- the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
-Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)</p></td>
- </tr>
-
- <tr>
- <td>ListWorksheets</td>
- <td><a href="#bytebase.v1.ListWorksheetsRequest">ListWorksheetsRequest</a></td>
- <td><a href="#bytebase.v1.ListWorksheetsResponse">ListWorksheetsResponse</a></td>
- <td><p>List worksheets.
-This is used for listing worksheets in a project, or across all projects by using `projects/-`.
-Permissions required: bb.worksheets.list</p></td>
- </tr>
-
- <tr>
- <td>ListWorksheetFolders</td>
- <td><a href="#bytebase.v1.ListWorksheetFoldersRequest">ListWorksheetFoldersRequest</a></td>
- <td><a href="#bytebase.v1.ListWorksheetFoldersResponse">ListWorksheetFoldersResponse</a></td>
- <td><p>List the caller&#39;s worksheet folders.
-Only folders stored in the caller&#39;s worksheet organizer are returned.</p></td>
+ <td>CreateWorkloadIdentity</td>
+ <td><a href="#bytebase.v1.CreateWorkloadIdentityRequest">CreateWorkloadIdentityRequest</a></td>
+ <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
+ <td><p>Creates a new workload identity.
+For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.create on workspace.
+For project-level: parent is projects/{project}, permission bb.workloadIdentities.create on project.</p></td>
</tr>
<tr>
- <td>SearchWorksheets</td>
- <td><a href="#bytebase.v1.SearchWorksheetsRequest">SearchWorksheetsRequest</a></td>
- <td><a href="#bytebase.v1.SearchWorksheetsResponse">SearchWorksheetsResponse</a></td>
- <td><p>Search for worksheets.
-This is used for finding my worksheets or worksheets shared by other people.
-The sheet accessibility is the same as GetWorksheet().
-Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)</p></td>
+ <td>GetWorkloadIdentity</td>
+ <td><a href="#bytebase.v1.GetWorkloadIdentityRequest">GetWorkloadIdentityRequest</a></td>
+ <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
+ <td><p>Gets a workload identity by name.
+Permissions required: bb.workloadIdentities.get</p></td>
</tr>
<tr>
- <td>UpdateWorksheet</td>
- <td><a href="#bytebase.v1.UpdateWorksheetRequest">UpdateWorksheetRequest</a></td>
- <td><a href="#bytebase.v1.Worksheet">Worksheet</a></td>
- <td><p>Update a worksheet.
-The users can access this method if,
-- they are the creator of the worksheet;
-- they have bb.worksheets.manage permission on the workspace;
-- the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
-Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)</p></td>
+ <td>ListWorkloadIdentities</td>
+ <td><a href="#bytebase.v1.ListWorkloadIdentitiesRequest">ListWorkloadIdentitiesRequest</a></td>
+ <td><a href="#bytebase.v1.ListWorkloadIdentitiesResponse">ListWorkloadIdentitiesResponse</a></td>
+ <td><p>Lists workload identities.
+For workspace-level: parent is workspaces/{id}, permission bb.workloadIdentities.list on workspace.
+For project-level: parent is projects/{project}, permission bb.workloadIdentities.list on project.</p></td>
</tr>
<tr>
- <td>UpdateWorksheetOrganizer</td>
- <td><a href="#bytebase.v1.UpdateWorksheetOrganizerRequest">UpdateWorksheetOrganizerRequest</a></td>
- <td><a href="#bytebase.v1.WorksheetOrganizer">WorksheetOrganizer</a></td>
- <td><p>Update the organizer of a worksheet.
-The access is the same as UpdateWorksheet method.
-Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)</p></td>
+ <td>UpdateWorkloadIdentity</td>
+ <td><a href="#bytebase.v1.UpdateWorkloadIdentityRequest">UpdateWorkloadIdentityRequest</a></td>
+ <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
+ <td><p>Updates a workload identity.
+Permissions required: bb.workloadIdentities.update</p></td>
</tr>
<tr>
- <td>BatchUpdateWorksheetOrganizer</td>
- <td><a href="#bytebase.v1.BatchUpdateWorksheetOrganizerRequest">BatchUpdateWorksheetOrganizerRequest</a></td>
- <td><a href="#bytebase.v1.BatchUpdateWorksheetOrganizerResponse">BatchUpdateWorksheetOrganizerResponse</a></td>
- <td><p>Batch update the organizers of worksheets.
-The access is the same as UpdateWorksheet method.
-Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)</p></td>
+ <td>DeleteWorkloadIdentity</td>
+ <td><a href="#bytebase.v1.DeleteWorkloadIdentityRequest">DeleteWorkloadIdentityRequest</a></td>
+ <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
+ <td><p>Deletes a workload identity.
+Permissions required: bb.workloadIdentities.delete</p></td>
</tr>
<tr>
- <td>DeleteWorksheet</td>
- <td><a href="#bytebase.v1.DeleteWorksheetRequest">DeleteWorksheetRequest</a></td>
- <td><a href="#google.protobuf.Empty">.google.protobuf.Empty</a></td>
- <td><p>Delete a worksheet.
-The access is the same as UpdateWorksheet method.
-Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)</p></td>
+ <td>UndeleteWorkloadIdentity</td>
+ <td><a href="#bytebase.v1.UndeleteWorkloadIdentityRequest">UndeleteWorkloadIdentityRequest</a></td>
+ <td><a href="#bytebase.v1.WorkloadIdentity">WorkloadIdentity</a></td>
+ <td><p>Restores a deleted workload identity.
+Permissions required: bb.workloadIdentities.undelete</p></td>
</tr>
</tbody>
@@ -35105,29 +35121,26 @@ Permissions required: bb.worksheets.manage (or creator, or project member for PR
<tr>
- <td>CreateWorksheet</td>
+ <td>CreateWorkloadIdentity</td>
<td>POST</td>
- <td>/v1/{parent=projects/*}/worksheets</td>
- <td>worksheet</td>
+ <td>/v1/{parent=projects/*}/workloadIdentities</td>
+ <td>workload_identity</td>
</tr>
-
-
-
<tr>
- <td>GetWorksheet</td>
- <td>GET</td>
- <td>/v1/{name=projects/*/worksheets/*}</td>
- <td></td>
+ <td>CreateWorkloadIdentity</td>
+ <td>POST</td>
+ <td>/v1/{parent=workspaces/*}/workloadIdentities</td>
+ <td>workload_identity</td>
</tr>
<tr>
- <td>ListWorksheets</td>
+ <td>GetWorkloadIdentity</td>
<td>GET</td>
- <td>/v1/{parent=projects/*}/worksheets</td>
+ <td>/v1/{name=workloadIdentities/*}</td>
<td></td>
</tr>
@@ -35135,63 +35148,50 @@ Permissions required: bb.worksheets.manage (or creator, or project member for PR
<tr>
- <td>ListWorksheetFolders</td>
+ <td>ListWorkloadIdentities</td>
<td>GET</td>
- <td>/v1/{parent=projects/*}/worksheetFolders</td>
+ <td>/v1/{parent=projects/*}/workloadIdentities</td>
<td></td>
</tr>
-
-
-
<tr>
- <td>SearchWorksheets</td>
- <td>POST</td>
- <td>/v1/{parent=projects/*}/worksheets:search</td>
- <td>*</td>
+ <td>ListWorkloadIdentities</td>
+ <td>GET</td>
+ <td>/v1/{parent=workspaces/*}/workloadIdentities</td>
+ <td></td>
</tr>
<tr>
- <td>UpdateWorksheet</td>
+ <td>UpdateWorkloadIdentity</td>
<td>PATCH</td>
- <td>/v1/{worksheet.name=projects/*/worksheets/*}</td>
- <td>worksheet</td>
+ <td>/v1/{workload_identity.name=workloadIdentities/*}</td>
+ <td>workload_identity</td>
</tr>
<tr>
- <td>UpdateWorksheetOrganizer</td>
- <td>PATCH</td>
- <td>/v1/{organizer.worksheet=projects/*/worksheets/*}/organizer</td>
- <td>organizer</td>
+ <td>DeleteWorkloadIdentity</td>
+ <td>DELETE</td>
+ <td>/v1/{name=workloadIdentities/*}</td>
+ <td></td>
</tr>
<tr>
- <td>BatchUpdateWorksheetOrganizer</td>
+ <td>UndeleteWorkloadIdentity</td>
<td>POST</td>
- <td>/v1/{parent=projects/*}/worksheets/organizers:batchUpdate</td>
+ <td>/v1/{name=workloadIdentities/*}:undelete</td>
<td>*</td>
</tr>
-
-
- <tr>
- <td>DeleteWorksheet</td>
- <td>DELETE</td>
- <td>/v1/{name=projects/*/worksheets/*}</td>
- <td></td>
- </tr>
-
-
</tbody>
</table>
diff --git a/proto/v1/v1/saved_query_service.proto b/proto/v1/v1/saved_query_service.proto
new file mode 100644
index 0000000000..faebcccea3
--- /dev/null
+++ b/proto/v1/v1/saved_query_service.proto
@@ -0,0 +1,399 @@
+syntax = "proto3";
+
+package bytebase.v1;
+
+import "buf/validate/validate.proto";
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+import "v1/annotation.proto";
+
+option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";
+
+// SavedQueryService manages saved queries for SQL Editor query development.
+// Permission IDs still use the legacy `bb.worksheets.*` names; they are
+// renamed together with the access-model redesign and its role migration.
+service SavedQueryService {
+ // Creates a personal saved query used in SQL Editor. Any authenticated user can create their own saved queries.
+ // Permissions required: None (authenticated users only)
+ rpc CreateSavedQuery(CreateSavedQueryRequest) returns (SavedQuery) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*}/savedQueries"
+ body: "saved_query"
+ };
+ option (google.api.method_signature) = "parent,saved_query";
+ option (bytebase.v1.auth_method) = CUSTOM;
+ }
+
+ // Get a saved query by name.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.get permission on the workspace;
+ // - the saved query is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ rpc GetSavedQuery(GetSavedQueryRequest) returns (SavedQuery) {
+ option (google.api.http) = {get: "/v1/{name=projects/*/savedQueries/*}"};
+ option (google.api.method_signature) = "name";
+ option (bytebase.v1.auth_method) = CUSTOM;
+ }
+
+ // List saved queries.
+ // This is used for listing saved queries in a project, or across all projects by using `projects/-`.
+ // Permissions required: bb.worksheets.list
+ rpc ListSavedQueries(ListSavedQueriesRequest) returns (ListSavedQueriesResponse) {
+ option (google.api.http) = {get: "/v1/{parent=projects/*}/savedQueries"};
+ option (google.api.method_signature) = "parent";
+ option (bytebase.v1.permission) = "bb.worksheets.list";
+ option (bytebase.v1.auth_method) = IAM;
+ }
+
+ // List the caller's saved query folders.
+ // Only folders stored in the caller's saved query organizer are returned.
+ rpc ListSavedQueryFolders(ListSavedQueryFoldersRequest) returns (ListSavedQueryFoldersResponse) {
+ option (google.api.http) = {get: "/v1/{parent=projects/*}/savedQueryFolders"};
+ option (google.api.method_signature) = "parent";
+ option (bytebase.v1.auth_method) = CUSTOM;
+ }
+
+ // Search for saved queries.
+ // This is used for finding my saved queries or saved queries shared by other people.
+ // The saved query accessibility is the same as GetSavedQuery().
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ rpc SearchSavedQueries(SearchSavedQueriesRequest) returns (SearchSavedQueriesResponse) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*}/savedQueries:search"
+ body: "*"
+ };
+ option (google.api.method_signature) = "parent";
+ option (bytebase.v1.auth_method) = CUSTOM;
+ }
+
+ // Update a saved query.
+ // The users can access this method if,
+ // - they are the creator of the saved query;
+ // - they have bb.worksheets.manage permission on the workspace;
+ // - the saved query is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ rpc UpdateSavedQuery(UpdateSavedQueryRequest) returns (SavedQuery) {
+ option (google.api.http) = {
+ patch: "/v1/{saved_query.name=projects/*/savedQueries/*}"
+ body: "saved_query"
+ };
+ option (google.api.method_signature) = "saved_query,update_mask";
+ option (bytebase.v1.auth_method) = CUSTOM;
+ }
+
+ // Update the organizer of a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ rpc UpdateSavedQueryOrganizer(UpdateSavedQueryOrganizerRequest) returns (SavedQueryOrganizer) {
+ option (google.api.http) = {
+ patch: "/v1/{organizer.saved_query=projects/*/savedQueries/*}/organizer"
+ body: "organizer"
+ };
+ option (google.api.method_signature) = "organizer,update_mask";
+ option (bytebase.v1.auth_method) = CUSTOM;
+ }
+
+ // Batch update the organizers of saved queries.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.get (or creator, or project member for shared saved queries)
+ rpc BatchUpdateSavedQueryOrganizer(BatchUpdateSavedQueryOrganizerRequest) returns (BatchUpdateSavedQueryOrganizerResponse) {
+ option (google.api.http) = {
+ post: "/v1/{parent=projects/*}/savedQueries/organizers:batchUpdate"
+ body: "*"
+ };
+ option (google.api.method_signature) = "parent,organizer,update_mask";
+ option (bytebase.v1.auth_method) = CUSTOM;
+ }
+
+ // Delete a saved query.
+ // The access is the same as UpdateSavedQuery method.
+ // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE saved queries)
+ rpc DeleteSavedQuery(DeleteSavedQueryRequest) returns (google.protobuf.Empty) {
+ option (google.api.http) = {delete: "/v1/{name=projects/*/savedQueries/*}"};
+ option (google.api.method_signature) = "name";
+ option (bytebase.v1.auth_method) = CUSTOM;
+ }
+}
+
+message CreateSavedQueryRequest {
+ // The parent resource where this saved query will be created.
+ // Format: projects/{project}
+ string parent = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // The saved query to create.
+ SavedQuery saved_query = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+message GetSavedQueryRequest {
+ // The name of the saved query to retrieve.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ string name = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+message ListSavedQueriesRequest {
+ // The parent resource of the saved queries.
+ // Format: projects/{project}
+ // Use "projects/-" to list saved queries across all projects.
+ string parent = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.resource_reference) = {type: "bytebase.com/Project"}
+ ];
+
+ // To filter the list result.
+ // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ //
+ // Supported filter:
+ // - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ //
+ // For example:
+ // creator == "users/{email}"
+ // creator != "users/{email}"
+ string filter = 2;
+
+ // The maximum number of saved queries to return. The service may return fewer than
+ // this value.
+ // If unspecified, at most 10 saved queries will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ int32 page_size = 3;
+
+ // A page token, received from a previous `ListSavedQueries` call.
+ // Provide this to retrieve the subsequent page.
+ //
+ // When paginating, all other parameters provided to `ListSavedQueries` must match
+ // the call that provided the page token.
+ string page_token = 4;
+}
+
+message ListSavedQueriesResponse {
+ // The saved queries from the specified parent.
+ repeated SavedQuery saved_queries = 1;
+
+ // A token to retrieve next page of saved queries.
+ // Pass this value in the page_token field in the subsequent call to
+ // `ListSavedQueries` method to retrieve the next page of saved queries.
+ string next_page_token = 2;
+}
+
+message ListSavedQueryFoldersRequest {
+ // The parent resource of the saved query folders.
+ // Format: projects/{project}
+ string parent = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+message ListSavedQueryFoldersResponse {
+ // The caller's saved query folders.
+ repeated SavedQueryFolder folders = 1;
+}
+
+message SavedQueryFolder {
+ enum Category {
+ CATEGORY_UNSPECIFIED = 0;
+ MINE = 1;
+ SHARED = 2;
+ }
+
+ // The folder path segments.
+ repeated string folders = 1;
+
+ // The folder category.
+ Category category = 2;
+}
+
+message UpdateSavedQueryRequest {
+ // The saved query to update.
+ //
+ // The saved query's `name` field is used to identify the saved query to update.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ SavedQuery saved_query = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // The list of fields to be updated.
+ // Fields are specified relative to the saved query.
+ // (e.g., `title`, `statement`; *not* `saved_query.title` or `saved_query.statement`)
+ // Only support update the following fields for now:
+ // - `title`
+ // - `statement`
+ // - `starred`
+ // - `visibility`
+ google.protobuf.FieldMask update_mask = 2;
+}
+
+message BatchUpdateSavedQueryOrganizerRequest {
+ // The parent resource whose saved queries' organizers are updated.
+ // Format: projects/{project}
+ string parent = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // To filter the batch update target.
+ // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ //
+ // Supported filter:
+ // - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ // - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ // - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ // - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ // - folder: the saved query organizer folder path, support exact "==" operator.
+ string filter = 2;
+
+ // The organizer fields to update.
+ SavedQueryOrganizer organizer = 3 [(google.api.field_behavior) = REQUIRED];
+
+ // The list of fields to be updated.
+ // Fields are specified relative to the saved query organizer.
+ // Only support update the following fields for now:
+ // - `starred`
+ // - `folders`
+ google.protobuf.FieldMask update_mask = 4 [(google.api.field_behavior) = REQUIRED];
+}
+
+message BatchUpdateSavedQueryOrganizerResponse {
+ repeated SavedQueryOrganizer saved_query_organizers = 1;
+
+ int32 updated_count = 2;
+}
+
+message UpdateSavedQueryOrganizerRequest {
+ // The organizer to update.
+ //
+ // The organizer's `saved_query` field is used to identify the saved query.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ SavedQueryOrganizer organizer = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // The list of fields to be updated.
+ // Fields are specified relative to the saved query organizer.
+ // Only support update the following fields for now:
+ // - `starred`
+ google.protobuf.FieldMask update_mask = 2;
+
+ // If set to true, and the saved query organizer is not found, a new saved query organizer will be created.
+ // In this situation, `update_mask` is ignored.
+ bool allow_missing = 3;
+}
+
+message SavedQueryOrganizer {
+ // The name of the saved query.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ string saved_query = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // starred means if the saved query is starred.
+ bool starred = 2;
+
+ repeated string folders = 3;
+}
+
+message DeleteSavedQueryRequest {
+ // The name of the saved query to delete.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ string name = 1 [(google.api.field_behavior) = REQUIRED];
+}
+
+message SearchSavedQueriesRequest {
+ // The parent resource of the saved queries.
+ // Format: projects/{project}
+ string parent = 1 [(google.api.field_behavior) = REQUIRED];
+
+ // To filter the search result.
+ // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
+ //
+ // Supported filter:
+ // - name: the saved query name in "projects/{project}/savedQueries/{savedQuery}" format, support "==" and "in [xx]" operator.
+ // - title: the saved query title, support "contains" operator.
+ // - creator: the saved query creator in "users/{email}" format, support "==" and "!=" operator.
+ // - starred: should be "true" or "false", filter starred/unstarred saved queries, support "==" operator.
+ // - visibility: check Visibility enum in the SavedQuery message for values, support "==" and "in [xx]" operator.
+ // - folder: the saved query organizer folder path, support "==" operator.
+ //
+ // For example:
+ // creator == "users/{email}"
+ // title.contains("saved query title")
+ // creator != "users/{email}"
+ // starred == true
+ // starred == false
+ // visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
+ // visibility == "PRIVATE"
+ // folder == "foo/bar"
+ string filter = 2;
+
+ // The maximum number of saved queries to return. The service may return fewer than
+ // this value.
+ // If unspecified, at most 10 saved queries will be returned.
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
+ int32 page_size = 3;
+
+ // A page token, received from a previous `SearchSavedQueries` call.
+ // Provide this to retrieve the subsequent page.
+ string page_token = 4;
+}
+
+message SearchSavedQueriesResponse {
+ // The saved queries that matched the search criteria.
+ repeated SavedQuery saved_queries = 1;
+
+ // A token to retrieve next page of saved queries.
+ // Pass this value in the page_token field in the subsequent call to
+ // `SearchSavedQueries` method to retrieve the next page of saved queries.
+ string next_page_token = 2;
+}
+
+message SavedQuery {
+ // The name of the saved query resource, generated by the server.
+ // Canonical parent is project.
+ // Format: projects/{project}/savedQueries/{savedQuery}
+ string name = 1 [
+ (google.api.field_behavior) = REQUIRED,
+ (google.api.field_behavior) = IMMUTABLE
+ ];
+
+ // The project resource name.
+ // Format: projects/{project}
+ string project = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The database resource name.
+ // Format: instances/{instance}/databases/{database}
+ // If the database parent doesn't exist, the database field is empty.
+ string database = 3;
+
+ // The title of the saved query.
+ string title = 4 [
+ (google.api.field_behavior) = REQUIRED,
+ (buf.validate.field).string.max_len = 200
+ ];
+
+ // The creator of the SavedQuery.
+ // Format: users/{email}
+ string creator = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The create time of the saved query.
+ google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The last update time of the saved query.
+ google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ // The content of the saved query.
+ // By default, it will be cut off in SearchSavedQueries() method. If it doesn't match the `content_size`, you can
+ // use GetSavedQuery() request to retrieve the full content.
+ bytes content = 8 [(google.api.field_behavior) = REQUIRED];
+
+ // content_size is the full size of the content, may not match the size of the `content` field.
+ int64 content_size = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+ enum Visibility {
+ VISIBILITY_UNSPECIFIED = 0;
+ // Read access in project scope, saved query OWNER/DBA and project OWNER can read/write, other project members can read.
+ PROJECT_READ = 1;
+ // Write access in project scope, saved query OWNER/DBA and all members in the project can write the saved query.
+ PROJECT_WRITE = 2;
+ // Private, only saved query OWNER can read/write.
+ PRIVATE = 3;
+ }
+ Visibility visibility = 10 [(google.api.field_behavior) = REQUIRED];
+
+ // starred indicates whether the saved query 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];
+}
diff --git a/proto/v1/v1/worksheet_service.proto b/proto/v1/v1/worksheet_service.proto
deleted file mode 100644
index 42871cd169..0000000000
--- a/proto/v1/v1/worksheet_service.proto
+++ /dev/null
@@ -1,397 +0,0 @@
-syntax = "proto3";
-
-package bytebase.v1;
-
-import "buf/validate/validate.proto";
-import "google/api/annotations.proto";
-import "google/api/client.proto";
-import "google/api/field_behavior.proto";
-import "google/api/resource.proto";
-import "google/protobuf/empty.proto";
-import "google/protobuf/field_mask.proto";
-import "google/protobuf/timestamp.proto";
-import "v1/annotation.proto";
-
-option go_package = "github.com/bytebase/bytebase/backend/generated-go/v1";
-
-// WorksheetService manages SQL worksheets for query development.
-service WorksheetService {
- // Creates a personal worksheet used in SQL Editor. Any authenticated user can create their own worksheets.
- // Permissions required: None (authenticated users only)
- rpc CreateWorksheet(CreateWorksheetRequest) returns (Worksheet) {
- option (google.api.http) = {
- post: "/v1/{parent=projects/*}/worksheets"
- body: "worksheet"
- };
- option (google.api.method_signature) = "parent,worksheet";
- option (bytebase.v1.auth_method) = CUSTOM;
- }
-
- // Get a worksheet by name.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.get permission on the workspace;
- // - the sheet is shared with them with PROJECT_READ and PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- rpc GetWorksheet(GetWorksheetRequest) returns (Worksheet) {
- option (google.api.http) = {get: "/v1/{name=projects/*/worksheets/*}"};
- option (google.api.method_signature) = "name";
- option (bytebase.v1.auth_method) = CUSTOM;
- }
-
- // List worksheets.
- // This is used for listing worksheets in a project, or across all projects by using `projects/-`.
- // Permissions required: bb.worksheets.list
- rpc ListWorksheets(ListWorksheetsRequest) returns (ListWorksheetsResponse) {
- option (google.api.http) = {get: "/v1/{parent=projects/*}/worksheets"};
- option (google.api.method_signature) = "parent";
- option (bytebase.v1.permission) = "bb.worksheets.list";
- option (bytebase.v1.auth_method) = IAM;
- }
-
- // List the caller's worksheet folders.
- // Only folders stored in the caller's worksheet organizer are returned.
- rpc ListWorksheetFolders(ListWorksheetFoldersRequest) returns (ListWorksheetFoldersResponse) {
- option (google.api.http) = {get: "/v1/{parent=projects/*}/worksheetFolders"};
- option (google.api.method_signature) = "parent";
- option (bytebase.v1.auth_method) = CUSTOM;
- }
-
- // Search for worksheets.
- // This is used for finding my worksheets or worksheets shared by other people.
- // The sheet accessibility is the same as GetWorksheet().
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- rpc SearchWorksheets(SearchWorksheetsRequest) returns (SearchWorksheetsResponse) {
- option (google.api.http) = {
- post: "/v1/{parent=projects/*}/worksheets:search"
- body: "*"
- };
- option (google.api.method_signature) = "parent";
- option (bytebase.v1.auth_method) = CUSTOM;
- }
-
- // Update a worksheet.
- // The users can access this method if,
- // - they are the creator of the worksheet;
- // - they have bb.worksheets.manage permission on the workspace;
- // - the sheet is shared with them with PROJECT_WRITE visibility, and they have bb.projects.get permission on the project.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- rpc UpdateWorksheet(UpdateWorksheetRequest) returns (Worksheet) {
- option (google.api.http) = {
- patch: "/v1/{worksheet.name=projects/*/worksheets/*}"
- body: "worksheet"
- };
- option (google.api.method_signature) = "worksheet,update_mask";
- option (bytebase.v1.auth_method) = CUSTOM;
- }
-
- // Update the organizer of a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- rpc UpdateWorksheetOrganizer(UpdateWorksheetOrganizerRequest) returns (WorksheetOrganizer) {
- option (google.api.http) = {
- patch: "/v1/{organizer.worksheet=projects/*/worksheets/*}/organizer"
- body: "organizer"
- };
- option (google.api.method_signature) = "organizer,update_mask";
- option (bytebase.v1.auth_method) = CUSTOM;
- }
-
- // Batch update the organizers of worksheets.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.get (or creator, or project member for shared worksheets)
- rpc BatchUpdateWorksheetOrganizer(BatchUpdateWorksheetOrganizerRequest) returns (BatchUpdateWorksheetOrganizerResponse) {
- option (google.api.http) = {
- post: "/v1/{parent=projects/*}/worksheets/organizers:batchUpdate"
- body: "*"
- };
- option (google.api.method_signature) = "parent,organizer,update_mask";
- option (bytebase.v1.auth_method) = CUSTOM;
- }
-
- // Delete a worksheet.
- // The access is the same as UpdateWorksheet method.
- // Permissions required: bb.worksheets.manage (or creator, or project member for PROJECT_WRITE worksheets)
- rpc DeleteWorksheet(DeleteWorksheetRequest) returns (google.protobuf.Empty) {
- option (google.api.http) = {delete: "/v1/{name=projects/*/worksheets/*}"};
- option (google.api.method_signature) = "name";
- option (bytebase.v1.auth_method) = CUSTOM;
- }
-}
-
-message CreateWorksheetRequest {
- // The parent resource where this worksheet will be created.
- // Format: projects/{project}
- string parent = 1 [(google.api.field_behavior) = REQUIRED];
-
- // The worksheet to create.
- Worksheet worksheet = 2 [(google.api.field_behavior) = REQUIRED];
-}
-
-message GetWorksheetRequest {
- // The name of the worksheet to retrieve.
- // Format: projects/{project}/worksheets/{worksheet}
- string name = 1 [(google.api.field_behavior) = REQUIRED];
-}
-
-message ListWorksheetsRequest {
- // The parent resource of the worksheets.
- // Format: projects/{project}
- // Use "projects/-" to list worksheets across all projects.
- string parent = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.resource_reference) = {type: "bytebase.com/Project"}
- ];
-
- // To filter the list result.
- // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- //
- // Supported filter:
- // - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- //
- // For example:
- // creator == "users/{email}"
- // creator != "users/{email}"
- string filter = 2;
-
- // The maximum number of worksheets to return. The service may return fewer than
- // this value.
- // If unspecified, at most 10 worksheets will be returned.
- // The maximum value is 1000; values above 1000 will be coerced to 1000.
- int32 page_size = 3;
-
- // A page token, received from a previous `ListWorksheets` call.
- // Provide this to retrieve the subsequent page.
- //
- // When paginating, all other parameters provided to `ListWorksheets` must match
- // the call that provided the page token.
- string page_token = 4;
-}
-
-message ListWorksheetsResponse {
- // The worksheets from the specified parent.
- repeated Worksheet worksheets = 1;
-
- // A token to retrieve next page of worksheets.
- // Pass this value in the page_token field in the subsequent call to
- // `ListWorksheets` method to retrieve the next page of worksheets.
- string next_page_token = 2;
-}
-
-message ListWorksheetFoldersRequest {
- // The parent resource of the worksheet folders.
- // Format: projects/{project}
- string parent = 1 [(google.api.field_behavior) = REQUIRED];
-}
-
-message ListWorksheetFoldersResponse {
- // The caller's worksheet folders.
- repeated WorksheetFolder folders = 1;
-}
-
-message WorksheetFolder {
- enum Category {
- CATEGORY_UNSPECIFIED = 0;
- MINE = 1;
- SHARED = 2;
- }
-
- // The folder path segments.
- repeated string folders = 1;
-
- // The folder category.
- Category category = 2;
-}
-
-message UpdateWorksheetRequest {
- // The worksheet to update.
- //
- // The worksheet's `name` field is used to identify the worksheet to update.
- // Format: projects/{project}/worksheets/{worksheet}
- Worksheet worksheet = 1 [(google.api.field_behavior) = REQUIRED];
-
- // The list of fields to be updated.
- // Fields are specified relative to the worksheet.
- // (e.g., `title`, `statement`; *not* `worksheet.title` or `worksheet.statement`)
- // Only support update the following fields for now:
- // - `title`
- // - `statement`
- // - `starred`
- // - `visibility`
- google.protobuf.FieldMask update_mask = 2;
-}
-
-message BatchUpdateWorksheetOrganizerRequest {
- // The parent resource whose worksheets' organizers are updated.
- // Format: projects/{project}
- string parent = 1 [(google.api.field_behavior) = REQUIRED];
-
- // To filter the batch update target.
- // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- //
- // Supported filter:
- // - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- // - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- // - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- // - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- // - folder: the worksheet organizer folder path, support exact "==" operator.
- string filter = 2;
-
- // The organizer fields to update.
- WorksheetOrganizer organizer = 3 [(google.api.field_behavior) = REQUIRED];
-
- // The list of fields to be updated.
- // Fields are specified relative to the worksheet organizer.
- // Only support update the following fields for now:
- // - `starred`
- // - `folders`
- google.protobuf.FieldMask update_mask = 4 [(google.api.field_behavior) = REQUIRED];
-}
-
-message BatchUpdateWorksheetOrganizerResponse {
- repeated WorksheetOrganizer worksheet_organizers = 1;
-
- int32 updated_count = 2;
-}
-
-message UpdateWorksheetOrganizerRequest {
- // The organizer to update.
- //
- // The organizer's `worksheet` field is used to identify the worksheet.
- // Format: projects/{project}/worksheets/{worksheet}
- WorksheetOrganizer organizer = 1 [(google.api.field_behavior) = REQUIRED];
-
- // The list of fields to be updated.
- // Fields are specified relative to the worksheet organizer.
- // Only support update the following fields for now:
- // - `starred`
- google.protobuf.FieldMask update_mask = 2;
-
- // If set to true, and the worksheet organizer is not found, a new worksheet organizer will be created.
- // In this situation, `update_mask` is ignored.
- bool allow_missing = 3;
-}
-
-message WorksheetOrganizer {
- // The name of the worksheet.
- // Format: projects/{project}/worksheets/{worksheet}
- string worksheet = 1 [(google.api.field_behavior) = REQUIRED];
-
- // starred means if the worksheet is starred.
- bool starred = 2;
-
- repeated string folders = 3;
-}
-
-message DeleteWorksheetRequest {
- // The name of the worksheet to delete.
- // Format: projects/{project}/worksheets/{worksheet}
- string name = 1 [(google.api.field_behavior) = REQUIRED];
-}
-
-message SearchWorksheetsRequest {
- // The parent resource of the worksheets.
- // Format: projects/{project}
- string parent = 1 [(google.api.field_behavior) = REQUIRED];
-
- // To filter the search result.
- // The syntax and semantics of CEL are documented at https://github.com/google/cel-spec
- //
- // Supported filter:
- // - name: the worksheet name in "projects/{project}/worksheets/{worksheet}" format, support "==" and "in [xx]" operator.
- // - title: the worksheet title, support "contains" operator.
- // - creator: the worksheet creator in "users/{email}" format, support "==" and "!=" operator.
- // - starred: should be "true" or "false", filter starred/unstarred sheets, support "==" operator.
- // - visibility: check Visibility enum in the Worksheet message for values, support "==" and "in [xx]" operator.
- // - folder: the worksheet organizer folder path, support "==" operator.
- //
- // For example:
- // creator == "users/{email}"
- // title.contains("worksheet title")
- // creator != "users/{email}"
- // starred == true
- // starred == false
- // visibility in ["PRIVATE", "PROJECT_READ", "PROJECT_WRITE"]
- // visibility == "PRIVATE"
- // folder == "foo/bar"
- string filter = 2;
-
- // The maximum number of worksheets to return. The service may return fewer than
- // this value.
- // If unspecified, at most 10 worksheets will be returned.
- // The maximum value is 1000; values above 1000 will be coerced to 1000.
- int32 page_size = 3;
-
- // A page token, received from a previous `SearchWorksheets` call.
- // Provide this to retrieve the subsequent page.
- string page_token = 4;
-}
-
-message SearchWorksheetsResponse {
- // The worksheets that matched the search criteria.
- repeated Worksheet worksheets = 1;
-
- // A token to retrieve next page of worksheets.
- // Pass this value in the page_token field in the subsequent call to
- // `SearchWorksheets` method to retrieve the next page of worksheets.
- string next_page_token = 2;
-}
-
-message Worksheet {
- // The name of the worksheet resource, generated by the server.
- // Canonical parent is project.
- // Format: projects/{project}/worksheets/{worksheet}
- string name = 1 [
- (google.api.field_behavior) = REQUIRED,
- (google.api.field_behavior) = IMMUTABLE
- ];
-
- // The project resource name.
- // Format: projects/{project}
- string project = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The database resource name.
- // Format: instances/{instance}/databases/{database}
- // If the database parent doesn't exist, the database field is empty.
- string database = 3;
-
- // The title of the worksheet.
- string title = 4 [
- (google.api.field_behavior) = REQUIRED,
- (buf.validate.field).string.max_len = 200
- ];
-
- // The creator of the Worksheet.
- // Format: users/{email}
- string creator = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The create time of the worksheet.
- google.protobuf.Timestamp create_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The last update time of the worksheet.
- google.protobuf.Timestamp update_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- // The content of the worksheet.
- // By default, it will be cut off in SearchWorksheet() method. If it doesn't match the `content_size`, you can
- // use GetWorksheet() request to retrieve the full content.
- bytes content = 8 [(google.api.field_behavior) = REQUIRED];
-
- // content_size is the full size of the content, may not match the size of the `content` field.
- int64 content_size = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
-
- enum Visibility {
- VISIBILITY_UNSPECIFIED = 0;
- // Read access in project scope, worksheet OWNER/DBA and project OWNER can read/write, other project members can read.
- PROJECT_READ = 1;
- // Write access in project scope, worksheet OWNER/DBA and all members in the project can write the worksheet.
- PROJECT_WRITE = 2;
- // Private, only worksheet OWNER can read/write.
- PRIVATE = 3;
- }
- Visibility visibility = 10 [(google.api.field_behavior) = REQUIRED];
-
- // 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];
-}