Default package
Get desktop application:
View/edit binary Protocol Buffers messages
service Dekart
dekart.proto:5rpc CreateReport (, )
dekart.proto:7reports
message
dekart.proto:630(message has no fields)
message
dekart.proto:634optional report = 1
rpc ForkReport (, )
dekart.proto:8message
dekart.proto:622string report_id = 1
message
dekart.proto:626string report_id = 1
rpc UpdateReport (, )
dekart.proto:9message
dekart.proto:547string report_id = 1
string map_config = 2
string title = 3
repeated query = 4
repeated query_params = 5
optional readme = 6
message
dekart.proto:556(message has no fields)
rpc ArchiveReport (, )
dekart.proto:10message
dekart.proto:434string report_id = 1
bool archive = 2
message
dekart.proto:439(message has no fields)
rpc SetDiscoverable (, )
dekart.proto:11message
dekart.proto:353string report_id = 1
bool discoverable = 2
report is discoverable by other users of the same instance
bool allow_edit = 3
allow other users to edit the report
message
dekart.proto:359(message has no fields)
rpc PublishReport (, )
dekart.proto:12message
dekart.proto:99string report_id = 1
bool publish = 2
message
dekart.proto:104(message has no fields)
rpc AllowExportDatasets (, )
dekart.proto:13message
dekart.proto:84string report_id = 1
bool allow_export = 2
message
dekart.proto:89(message has no fields)
rpc AddReadme (, )
dekart.proto:14message
dekart.proto:69string report_id = 1
string markdown = 2
message
dekart.proto:74(message has no fields)
rpc RemoveReadme (, )
dekart.proto:15message
dekart.proto:77string report_id = 1
message
dekart.proto:81(message has no fields)
rpc CreateDataset (, )
dekart.proto:18datasets
message
dekart.proto:585string report_id = 1
message
dekart.proto:589(message has no fields)
rpc RemoveDataset (, )
dekart.proto:19message
dekart.proto:362string dataset_id = 1
message
dekart.proto:366string dataset_id = 1
rpc UpdateDatasetName (, )
dekart.proto:20message
dekart.proto:569string dataset_id = 1
string name = 2
message
dekart.proto:574(message has no fields)
message
dekart.proto:577string dataset_id = 1
string connection_id = 2
message
dekart.proto:582(message has no fields)
rpc CreateFile (, )
dekart.proto:24files
message
dekart.proto:592string dataset_id = 1
message
dekart.proto:596string file_id = 1
rpc CreateQuery (, )
dekart.proto:27queries
message
dekart.proto:600string dataset_id = 1
message
dekart.proto:604optional query = 1
rpc RunQuery (, )
dekart.proto:28message
dekart.proto:559string query_id = 1
string query_text = 2
repeated query_params = 3
string query_params_values = 4
url encoded
message
dekart.proto:566(message has no fields)
rpc RunAllQueries (, )
dekart.proto:29message
dekart.proto:216string report_id = 1
repeated query_params = 2
string query_params_values = 3
url encoded
message
dekart.proto:222(message has no fields)
rpc CancelJob (, )
dekart.proto:32jobs
message
dekart.proto:92string job_id = 1
message
dekart.proto:96(message has no fields)
rpc GetEnv (, )
dekart.proto:34message
dekart.proto:374(message has no fields)
message
dekart.proto:376repeated variables = 1
rpc GetReportStream (, stream )
dekart.proto:37streams
message
dekart.proto:608optional report = 1
optional stream_options = 2
message
dekart.proto:613optional report = 1
repeated queries = 2
optional stream_options = 3
repeated datasets = 4
repeated files = 5
repeated query_jobs = 6
rpc GetReportListStream (, stream )
dekart.proto:38message
dekart.proto:441optional stream_options = 1
message
dekart.proto:445repeated reports = 1
optional stream_options = 2
rpc GetUserStream (, stream )
dekart.proto:39message
dekart.proto:266optional stream_options = 1
message
dekart.proto:269rpc GetUsage (, )
dekart.proto:42statistics
message
dekart.proto:344(message has no fields)
message
dekart.proto:346int64 total_reports = 1
int64 total_queries = 2
int64 total_files = 3
int64 total_authors = 4
rpc CreateConnection (, )
dekart.proto:45connections
message
dekart.proto:305optional connection = 1
message
dekart.proto:309optional connection = 1
rpc GetGcpProjectList (, )
dekart.proto:46message
dekart.proto:202(message has no fields)
message
dekart.proto:205repeated string projects = 1
rpc UpdateConnection (, )
dekart.proto:47message
dekart.proto:297optional connection = 1
message
dekart.proto:301optional connection = 1
rpc ArchiveConnection (, )
dekart.proto:48message
dekart.proto:290string connection_id = 1
message
dekart.proto:294(message has no fields)
rpc GetConnectionList (, )
dekart.proto:49message
dekart.proto:259(message has no fields)
message
dekart.proto:262repeated connections = 1
rpc TestConnection (, )
dekart.proto:50message
dekart.proto:281optional connection = 1
message
dekart.proto:285bool success = 1
string error = 2
rpc SetDefaultConnection (, )
dekart.proto:51message
dekart.proto:209string connection_id = 1
message
dekart.proto:213(message has no fields)
rpc RespondToInvite (, )
dekart.proto:56user
message
dekart.proto:155string invite_id = 1
bool accept = 2
message
dekart.proto:160(message has no fields)
rpc CreateSubscription (, )
dekart.proto:59subscriptions
message
dekart.proto:250PlanType plan_type = 1
string ui_url = 2
message
dekart.proto:255string redirect_url = 1
message
dekart.proto:107string ui_url = 1
message
dekart.proto:111string url = 1
rpc CreateWorkspace (, )
dekart.proto:63workspace
message
dekart.proto:141string workspace_name = 1
message
dekart.proto:145(message has no fields)
rpc UpdateWorkspace (, )
dekart.proto:64message
dekart.proto:148string workspace_name = 1
message
dekart.proto:152(message has no fields)
rpc GetWorkspace (, )
dekart.proto:65message
dekart.proto:130(message has no fields)
message
dekart.proto:133optional Workspace = 1
optional subscription = 2
repeated users = 3
repeated invites = 4
int64 added_users_count = 5
to not duplicate count logic in UI
rpc UpdateWorkspaceUser (, )
dekart.proto:66message
dekart.proto:115string email = 1
UpdateWorkspaceUserRequest.UserUpdateType user_update_type = 2
UserRole role = 3
message
dekart.proto:127(message has no fields)
message
dekart.proto:418AuthState is used to pass state between UI, auth endpoint and Google OAuth via redirect
AuthState.Action action = 1
string auth_url = 2
dekart backend url to handle auth request
string ui_url = 3
dekart frontend url to redirect to after auth
string access_token_to_revoke = 4
access token to revoke
bool switch_account = 5
if true, user will be requested to switch account
bool sensitive_scope = 6
if true, user will be requested to grant sensitive scope
string login_hint = 7
login hint for Google OAuth
auth endpoint actions
Used in:
ACTION_UNSPECIFIED = 0
ACTION_REQUEST_CODE = 1
request auth code from Google OAuth (invoked by UI)
ACTION_REQUEST_TOKEN = 2
request access token from Google OAuth (used as callback from Google OAuth)
ACTION_REVOKE = 3
revoke access token (invoked by UI)
message
dekart.proto:319Used in: , , , , ,
string id = 1
string connection_name = 2
string bigquery_project_id = 3
string cloud_storage_bucket = 4
bool is_default = 5
string author_email = 6
int64 created_at = 7
int64 updated_at = 8
int64 dataset_count = 9
bool can_store_files = 10
ConnectionType connection_type = 11
string snowflake_account_id = 12
string snowflake_username = 13
optional snowflake_password = 14
string snowflake_warehouse = 15
optional bigquery_key = 16
Used in: ,
CONNECTION_TYPE_UNSPECIFIED = 0
CONNECTION_TYPE_BIGQUERY = 1
CONNECTION_TYPE_SNOWFLAKE = 2
message
dekart.proto:475Used in:
string id = 1
string report_id = 2
string query_id = 3
int64 created_at = 4
int64 updated_at = 5
string file_id = 6
string name = 7
string connection_id = 8
ConnectionType connection_type = 9
message
dekart.proto:529Used in:
string id = 1
string name = 2
string mime_type = 3
int64 size = 4
string source_id = 5
int64 created_at = 6
int64 updated_at = 7
File.Status file_status = 8
string upload_error = 9
Used in:
STATUS_UNSPECIFIED = 0
STATUS_NEW = 1
default initial state
STATUS_RECEIVED = 2
file uploaded by user to temp storage
STATUS_STORED = 3
file stored in permanent storage
message
dekart.proto:377Used in:
Variable.Type type = 1
string value = 2
Used in:
TYPE_UNSPECIFIED = 0
TYPE_MAPBOX_TOKEN = 1
TYPE_UX_DATA_DOCUMENTATION = 2
TYPE_UX_HOMEPAGE = 3
TYPE_ALLOW_FILE_UPLOAD = 4
TYPE_DATASOURCE = 5
TYPE_STORAGE = 6
TYPE_REQUIRE_AMAZON_OIDC = 7
TYPE_REQUIRE_IAP = 8
TYPE_DISABLE_USAGE_STATS = 9
TYPE_REQUIRE_GOOGLE_OAUTH = 10
TYPE_BIGQUERY_PROJECT_ID = 11
TYPE_CLOUD_STORAGE_BUCKET = 12
TYPE_UX_ACCESS_ERROR_INFO_HTML = 13
TYPE_UX_NOT_FOUND_ERROR_INFO_HTML = 14
TYPE_UX_SAMPLE_QUERY_SQL = 15
TYPE_AES_KEY = 16
TYPE_AES_IV = 17
TYPE_AUTH_ENABLED = 18
TYPE_USER_DEFINED_CONNECTION = 19
TYPE_UX_DISABLE_VERSION_CHECK = 20
TYPE_ALLOW_WORKSPACE_CREATION = 21
TYPE_WORKSPACE_DEFAULT_ROLE = 22
TYPE_SECRETS_ENABLED = 23
message
dekart.proto:164(message has no fields)
message
dekart.proto:175repeated invites = 1
Used in: , ,
TYPE_UNSPECIFIED = 0
TYPE_PERSONAL = 1
TYPE_TEAM = 2
TYPE_GROW = 3
TYPE_MAX = 4
TYPE_SELF_HOSTED = 5
message
dekart.proto:514Used in: , ,
string id = 1
string query_text = 2
int64 created_at = 3
int64 updated_at = 4
Query.QuerySource query_source = 5
string query_source_id = 6
Used in:
QUERY_SOURCE_UNSPECIFIED = 0
QUERY_SOURCE_INLINE = 1
QUERY_SOURCE_STORAGE = 2
message
dekart.proto:487Used in:
string id = 1
string query_id = 2
string query_text = 3
string job_result_id = 4
string job_error = 5
int64 job_duration = 6
int32 total_rows = 7
int64 bytes_processed = 8
int64 result_size = 9
int64 created_at = 10
int64 updated_at = 11
QueryJob.JobStatus job_status = 12
string dw_job_id = 13
string query_params_hash = 14
Used in:
JOB_STATUS_UNSPECIFIED = 0
JOB_STATUS_PENDING = 1
JOB_STATUS_RUNNING = 2
JOB_STATUS_DONE_LEGACY = 3
legacy for backwards compatibility
JOB_STATUS_READING_RESULTS = 4
job is done processing results
JOB_STATUS_DONE = 5
message
dekart.proto:638Used in: , , ,
string name = 1
string label = 2
QueryParam.Type type = 3
string default_value = 4
Used in:
TYPE_UNSPECIFIED = 0
TYPE_STRING = 1
message
dekart.proto:450Used in: ,
string markdown = 1
message
dekart.proto:411RedirectState is used to pass state between the server and the UI via redirect
string token_json = 1
string error = 2
bool sensitive_scopes_granted = 3
if true, sensitive scope are granted
message
dekart.proto:454Used in: , , ,
string id = 1
string map_config = 2
string title = 3
bool archived = 4
bool can_write = 5
user can write to the report because he is the author or has edit permission
string author_email = 6
bool discoverable = 7
report is discoverable by other users of the same instance
bool allow_edit = 8
allow other users to edit the report
bool is_author = 9
user is the author of the report
int64 created_at = 10
int64 updated_at = 11
bool is_sharable = 12
can be shared with other users (depends where result is stored)
bool need_sensitive_scope = 13
need sensitive scope to run queries and read results
bool is_playground = 14
true - playground, false - workspace
bool is_public = 15
true - public, false - private
bool allow_export = 16
allow export datasets
repeated query_params = 17
optional readme = 18
message
dekart.proto:338Used in:
string client_encrypted = 1
encrypted with client key
string server_encrypted = 2
encrypted with server key
int32 length = 3
length of the password for placeholder
message
dekart.proto:370Used in: , , , , ,
int64 sequence = 1
message
dekart.proto:231Used in:
PlanType plan_type = 2
int64 updated_at = 4
seconds
string customer_id = 6
string stripe_subscription_id = 7
string stripe_customer_email = 8
int64 cancel_at = 9
seconds
string item_id = 10
stripe subscription item id
Used in:
USER_UPDATE_TYPE_UNSPECIFIED = 0
USER_UPDATE_TYPE_ADD = 1
USER_UPDATE_TYPE_REMOVE = 2
USER_UPDATE_TYPE_UPDATE = 3
message
dekart.proto:194Used in:
string email = 1
int64 updated_at = 2
UserStatus status = 3
string invite_id = 4
UserRole role = 5
Used in: , ,
ROLE_UNSPECIFIED = 0
ROLE_ADMIN = 1
ROLE_EDITOR = 2
ROLE_VIEWER = 3
Used in:
USER_STATUS_UNSPECIFIED = 0
USER_STATUS_PENDING = 1
USER_STATUS_ACTIVE = 2
USER_STATUS_REMOVED = 3
USER_STATUS_REJECTED = 4
message
dekart.proto:226Used in:
string id = 1
string name = 2
message
dekart.proto:167Used in: ,
string workspace_id = 1
string invite_id = 2
string inviter_email = 3
string workspace_name = 4
int64 created_at = 5