Compare commits

...
Author SHA1 Message Date
Ruslan 499cda86b3 dbeaver/pro#9724 fix graphql schema for doc 2026-07-31 12:47:47 +02:00
Ruslan ca03a8eff3 dbeaver/pro#9724 fix graphql schema for doc 2026-07-31 11:24:19 +02:00
16 changed files with 68 additions and 20 deletions
@@ -1,3 +1,7 @@
####################################################
# Core API
####################################################
extend type ServerConfig {
serverURL: String! @deprecated
rootURI: String!
@@ -1,6 +1,10 @@
# Any object (JSON)
####################################################
# Base schema
####################################################
"Any object (JSON)"
scalar Object
# Date/Time
"Date/Time"
scalar DateTime
scalar Date
@@ -556,7 +556,7 @@ type ConnectionInfo {
supportedDataFormats: [ ResultDataFormat! ]!
configurationType: DriverConfigurationType
#Access properties
"Access properties"
canViewSettings: Boolean!
canEdit: Boolean!
canDelete: Boolean!
@@ -737,7 +737,7 @@ input ConnectionConfig {
"ID of database driver"
driverId: ID
# Custom connection parameters (all optional)
"Custom connection parameters (all optional)"
host: String
port: String
serverName: String
@@ -1,4 +1,7 @@
####################################################
# Datasource events
####################################################
extend enum CBServerEventId {
"Datasource created"
@@ -1,3 +1,7 @@
####################################################
# SQL events
####################################################
extend enum CBServerEventId {
"Database output log updated (e.g., DBMS in Oracle)"
cb_database_output_log_updated,
@@ -1,4 +1,6 @@
####################################################
# Nodes, objects and properties
####################################################
type ObjectDescriptor {
id: Int
@@ -143,7 +145,7 @@ extend type Query {
"Refreshes node based on the node path"
navRefreshNode( nodePath: ID! ): Boolean @deprecated # Use navReloadNode method from Mutation (24.2.4)
# contextId currently not using
"contextId currently not using"
navGetStructContainers( projectId: ID, connectionId: ID!, contextId: ID, catalog: ID ): DatabaseStructContainers!
}
@@ -38,7 +38,7 @@ type SQLCompletionProposal {
# Data read / SQL execution
####################################################
# SQL context must be created for each SQL editor
"SQL context must be created for each SQL editor"
type SQLContextInfo {
id: ID!
@@ -153,10 +153,12 @@ type SQLResultSet {
"Returns list of rows in the result set. Each row contains data and metadata"
rowsWithMetaData: [SQLResultRowMetaData] @since(version: "23.3.5")
# True means that resultset was generated by single entity query
# New rows can be added, old rows can be deleted
"""
True means that resultset was generated by single entity query
New rows can be added, old rows can be deleted
"""
singleEntity: Boolean!
# server always returns hasMoreData = false
"server always returns hasMoreData = false"
hasMoreData: Boolean!
"Identifies if result set has row identifier. If true then it is possible update data or load LOB files"
hasRowIdentifier: Boolean! @deprecated (reason: "use rowIdentifierState (25.3.4)")
@@ -213,7 +215,7 @@ type SQLQueryResults {
updateRowCount: Float
sourceQuery: String
# Actual data format of this result
"Actual data format of this result"
dataFormat: ResultDataFormat
resultSet: SQLResultSet
@@ -221,17 +223,17 @@ type SQLQueryResults {
type SQLExecuteInfo {
# Status message
"Status message"
statusMessage: String
# Execute time (ms)
"Execute time (ms)"
duration: Int!
# Actual conditions applied to query
"Actual conditions applied to query"
filterText: String
# Full query that was executed, contains all used filters
"Full query that was executed, contains all used filters"
fullQuery: String
# Original query that was executed, without modifications
"Original query that was executed, without modifications"
originalQuery: String
# Results
"Results"
results: [ SQLQueryResults! ]!
}
@@ -1,3 +1,7 @@
####################################################
# Administration API
####################################################
"Describes the type of the administrative subject (user or team)"
enum AdminSubjectType {
"User"
@@ -1,3 +1,7 @@
####################################################
# AI events
####################################################
extend enum CBServerEventId {
cb_ai_chat_message_chunk @since(version: "25.1.1")
cb_ai_chat_message_error @since(version: "25.1.1")
@@ -1,4 +1,7 @@
####################################################
# AI admin queries
####################################################
enum AIMessageType {
SYSTEM,
USER,
@@ -1,3 +1,7 @@
####################################################
# Authentication API
####################################################
enum AuthCredentialEncryption {
none,
plain,
@@ -15,11 +19,11 @@ type AuthCredentialInfo {
displayName: String!
description: String
# This field must be shown in admin panel
"This field must be shown in admin panel"
admin: Boolean!
# This field must be shown in login form
"This field must be shown in login form"
user: Boolean!
# This field can be used as user identifier
"This field can be used as user identifier"
identifying: Boolean!
possibleValues: [String]
@@ -1,4 +1,6 @@
####################################################
# Data transfer queries
####################################################
type DataTransferProcessorInfo {
id: ID!
@@ -1,3 +1,7 @@
####################################################
# File system API
####################################################
type FSFile @since(version: "23.2.2") {
"Name of the file or folder"
name: String!
@@ -1,4 +1,6 @@
####################################################
# Metadata queries
####################################################
extend type Query {
@@ -1,3 +1,7 @@
####################################################
# Resource manager events
####################################################
extend enum CBServerEventId {
"Resource manager resource created"
cb_rm_resource_created,
@@ -1,4 +1,6 @@
####################################################
# Metadata queries
####################################################
type RMProject {
id: ID!
@@ -17,7 +19,7 @@ type RMResource {
name: String!
folder: Boolean!
length: Int!
# Properties map
"Properties map"
properties: Object
}