Category: Database Schema#

The Database Schema category documents the core information of a database schema — i.e. the logical unit that groups tables, views, and other objects together. It represents the center of the database category chain in i-doit and links the schema with its instance and the hosting server.

Usage#

Typical use cases:

• Structure the database landscape: Every database schema is created as a separate i-doit object of the type Database schema. Through this category, it receives its basic data: name, storage engine, and the assignment to the database instance.
• Establish instance assignment: The field Database instance links the schema with the parent database instance. This results in a clear hierarchy: Server > Instance > Schema.
• Document the runtime environment: The field Runs on references the server or virtual machine on which the schema is operated. This makes dependencies between infrastructure and databases visible.
• Record storage engine: Especially with MySQL/MariaDB, the storage engine (e.g. InnoDB, MyISAM, Aria) is relevant for performance, transaction safety, and backup strategies. Here you can document this information per schema.

Fields#

Runs on#

Link to the server or virtual machine on which the database schema is operated. Via the object browser, you can select the corresponding infrastructure object. This link is crucial for impact analyses: If the server fails, all schemas running on it are affected.

Database instance#

The database instance to which this schema belongs, e.g. an Oracle SID, a PostgreSQL cluster instance, or a MySQL instance. Dialog field — the available instances are derived from the instance objects created in i-doit.

Title#

The name of the database schema, e.g. idoit_production, erp_main, or HR_DATA. Should exactly match the schema name in the database.

Storage engine#

The storage engine used, e.g. InnoDB, MyISAM, Aria, or PostgreSQL (for databases without a selectable engine). Free text field — enables documentation of any engine type.

Description#

Free text for additional details: purpose of the schema, associated application, backup frequency, character set, collation, or configuration special features.

Technical Reference#

Fields (API Reference)#

API Examples#

Create Entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 123,
        "category": "C__CATS__DATABASE_SCHEMA",
        "data": {
            "link": 45,
            "instance": "MySQL 8.0 Production",
            "title": "idoit_production",
            "storage_engine": "InnoDB",
            "description": "Production schema of the i-doit CMDB, UTF-8, daily backup at 02:00"
        }
    },
    "id": 1
}

Read Entries#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.read",
    "params": {
        "apikey": "your-api-key",
        "object": 123,
        "category": "C__CATS__DATABASE_SCHEMA"
    },
    "id": 2
}

Update Entry#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
    "jsonrpc": "2.0",
    "method": "cmdb.category.save",
    "params": {
        "apikey": "your-api-key",
        "object": 123,
        "category": "C__CATS__DATABASE_SCHEMA",
        "entry": 1,
        "data": {
            "storage_engine": "InnoDB",
            "description": "Migration to InnoDB completed, previously MyISAM"
        }
    },
    "id": 3
}