dbeaver/tech-docs#654 update gql comments, remove outdated info (#3012)

This commit is contained in:
Anastasiya
2024-10-18 18:38:56 +02:00
committed by GitHub
parent ffe0a18828
commit cbceee6ec3
@@ -514,18 +514,21 @@ input ConnectionConfig {
# Host, port, serverName, databaseName are also stored in mainPropertyValues for custom pages
mainPropertyValues: Object @since(version: "24.1.2")
# Connection url jdbc:{driver}://{host}[:{port}]/[{database}]
# Return connection URL jdbc:{driver}://{host}[:{port}]/[{database}]
url: String
# Properties
# Return properties list
properties: Object
# Keep-Alive interval
# Return keep-alive interval
keepAliveInterval: Int
# Return auto-commit connection state
autocommit: Boolean
# Template connection
# Return template connection state
template: Boolean
# Read-onyl connection
# Return read-only connection state
readOnly: Boolean
# User credentials
@@ -536,12 +539,10 @@ input ConnectionConfig {
selectedSecretId: ID @since(version: "23.3.5")
credentials: Object
# Map of provider properties (name/value)
# Return map of provider properties (name/value)
providerProperties: Object
# Network handlers. Map of id->property map (name/value).
# Return network handlers configuration. Map of id->property map (name/value).
networkHandlersConfig: [NetworkHandlerConfigInput!]
#### deprecated fields
@@ -565,15 +566,16 @@ input ConnectionConfig {
####################################################
extend type Query {
# Returns server config
# Return server config
serverConfig: ServerConfig!
# Return product settings
productSettings: ProductSettings! @since(version: "24.0.1")
# Returns session state ( initialize if not )
# Return session state ( initialize if not )
sessionState: SessionInfo!
# Session permissions
# Return session permissions
sessionPermissions: [ID]!
# Get driver info
@@ -581,9 +583,10 @@ extend type Query {
authModels: [DatabaseAuthModel!]!
networkHandlers: [NetworkHandlerDescriptor!]!
# List of user connections.
# Return list of user connections
userConnections( projectId: ID, id: ID, projectIds: [ID!] ): [ ConnectionInfo! ]!
# List of template connections.
# Return list of template connections by project ID
templateConnections( projectId: ID ): [ ConnectionInfo! ]!
# List of connection folders
@@ -613,21 +616,25 @@ extend type Mutation {
# Refresh session connection list
refreshSessionConnections: Boolean
# Refreshes session on server and returns its state
# Change session language to specified
changeSessionLanguage(locale: String): Boolean
# Create new custom connection. Custom connections exist only within the current session.
# Create new custom connection
createConnection( config: ConnectionConfig!, projectId: ID ): ConnectionInfo!
# Update specified connection
updateConnection( config: ConnectionConfig!, projectId: ID ): ConnectionInfo!
# Delete specified connection
deleteConnection( id: ID!, projectId: ID ): Boolean!
# Create new custom connection from template
createConnectionFromTemplate( templateId: ID!, projectId: ID!, connectionName: String ): ConnectionInfo!
# Create new folder
# Create new folder for connections
createConnectionFolder(parentFolderPath: ID, folderName: String!, projectId: ID ): ConnectionFolderInfo!
# Delete specified connection folder
deleteConnectionFolder( folderPath: ID!, projectId: ID ): Boolean!
# Copies connection configuration from node
@@ -636,7 +643,7 @@ extend type Mutation {
# Test connection configuration. Returns remote server version
testConnection( config: ConnectionConfig!, projectId: ID): ConnectionInfo!
# Test connection configuration. Returns remote server version
# Test network handler
testNetworkHandler( config: NetworkHandlerConfigInput! ): NetworkEndpointInfo!
# Initiate existing connection
@@ -646,7 +653,7 @@ extend type Mutation {
# Disconnect from database
closeConnection( id: ID!, projectId: ID ): ConnectionInfo!
# Changes navigator settings for connection
# Change navigator settings for connection
setConnectionNavigatorSettings( id: ID!, projectId: ID, settings: NavigatorSettingsInput!): ConnectionInfo!
#### Generic async functions