Apache Derby · JSON Structure

Apache Derby Connection Config Structure

JDBC connection configuration for Apache Derby in embedded or client/server mode.

Type: object Properties: 10 Required: 2
ApacheDatabaseEmbeddedJavaJDBCOpen SourceRelationalSQL

ConnectionConfig is a JSON Structure definition published by Apache Derby, describing 10 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

mode databaseName host port user password createDatabase bootPassword dataEncryption encryptionAlgorithm

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

apache-derby-connection-config-structure.json Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-derby/refs/heads/main/json-structure/apache-derby-connection-config-structure.json",
  "name": "ConnectionConfig",
  "description": "JDBC connection configuration for Apache Derby in embedded or client/server mode.",
  "type": "object",
  "properties": {
    "mode": {
      "type": "string",
      "description": "Derby deployment mode.",
      "enum": [
        "embedded",
        "client"
      ],
      "example": "embedded"
    },
    "databaseName": {
      "type": "string",
      "description": "Database name or path to create/connect to.",
      "example": "mydb"
    },
    "host": {
      "type": "string",
      "description": "Network Server hostname (client mode only).",
      "example": "localhost"
    },
    "port": {
      "type": "int32",
      "description": "Network Server port (client mode only).",
      "default": 1527,
      "example": 1527
    },
    "user": {
      "type": "string",
      "description": "Database user (when authentication is enabled).",
      "example": "app"
    },
    "password": {
      "type": "string",
      "description": "Database password (when authentication is enabled).",
      "example": "secretpassword"
    },
    "createDatabase": {
      "type": "string",
      "description": "Create the database if it does not exist.",
      "enum": [
        "create"
      ],
      "example": "create"
    },
    "bootPassword": {
      "type": "string",
      "description": "Boot password for encrypted databases."
    },
    "dataEncryption": {
      "type": "boolean",
      "description": "Enable data-at-rest encryption for this database.",
      "default": false,
      "example": false
    },
    "encryptionAlgorithm": {
      "type": "string",
      "description": "Encryption algorithm for encrypted databases.",
      "example": "AES/CBC/NoPadding"
    }
  },
  "required": [
    "mode",
    "databaseName"
  ]
}