Skip to main content

# Database

No description

    type Database implements MonitoredSystem {
      id: ID!
      mst: Int!
      checks(
        where: FilterInput
        order: OrderInput
      ): [Check!]!
      checkCount(
        where: FilterInput
      ): Int!
      checkCountSummary(
        filter: CheckKind
      ): CheckCountSummary!
      checksRelay(
        first: Int
        after: String
        where: FilterInput
        order: OrderInput
      ): CheckConnection
      customAttributes: [CustomAttribute!]!
      customData: String
      customer: Customer!
      description: String
      maintenance: Boolean
      monitorOff: Boolean
      monitorOffUntil: DateTime
      monitorSwitchReason: String
      monitorSwitchDate: DateTime
      name: String
      operational: Boolean
      operationalSince: Date
      operationalUntil: Date
      status: Status!
      statusId: Int!
      systemRole: String @deprecated
      role: SystemRole
      type: MonitoredSystemType!
      timestamp: DateTime
      uuid: String
      server: Server
      databaseType: String!
      user: UserPassword @deprecated
      user2: UserPassword @deprecated
      attributes: String @deprecated
      actions(
        actionType: [SystemActionType!] = [Start, Stop, Restart]
      ): [SystemAction!]!
      performance: MonitoredSystemPerformanceData
      version: String
      dbmsProduct: String
      administrator: User
      administratorDeputy: User
      businessObjects: [SapBusinessObject!]!
      remote: Boolean!
      info: [InfoNode]
      kind: DatabaseKind!
      sapSystem: SapSystem
      systemDatabase: Database
      applicationType: String
      assignedSLA: ServiceLevelAgreement
      monitorLevel: MonitorLevel!
      credentialPurposes: [CredentialsPurpose]!
      credentials: [CredentialsBase]!
      host: String
      port: Int
      notSeen: Boolean
      notifications(
        where: FilterInput
        order: OrderInput
      ): [Notification]!
      pagedNotifications(
        pageRequest: PageRequest!
        where: FilterInput
        order: OrderInput
      ): NotificationPage!
      settings: DatabaseSettings
      dbType: DatabaseType
      managedStatus: ManagedSystemStatus!
      monitoringParametersGroups: [MonitoringParameterGroup!]!
      monitoringParameterByName(
        name: String!
      ): ValueParameter
      draft: Boolean!
      application: ApplicationType
      changes(
        where: FilterInput
        order: OrderInput
      ): [Change!]!
      pagedChanges(
        pageRequest: PageRequest!
        where: FilterInput
        order: OrderInput
      ): ChangePage
      systemParameterSets: [SystemParameterSet!]!
    }

### Fields​

#### `Database.id` ● `ID!` non-null scalar​

#### `Database.mst` ● `Int!` non-null scalar​

The numeric monitored system type. 0 = Server 1 = SapInstance 2 = SapSystem 3 = Database (can be StandaloneDatabase or SapSystemDatabase) (4 = BusinessService) 5 = SapBusinessObject 6 = CloudService

#### `Database.checks` ● `[Check!]!` non-null interface​

Get all the available RTM checks for the given status selection. If the call should return different kind of checks the filter input has to be used with the explicit value for the kind field. If there is no kind filter field defined it defaults to: { name: "kind" operator: eq value: "RTM" }

##### `Database.checks.where` ● `FilterInput` input​

The filter conditions for this query.

##### `Database.checks.order` ● `OrderInput` input​

The order of the results.

#### `Database.checkCount` ● `Int!` non-null scalar​

Count the affected checks.

##### `Database.checkCount.where` ● `FilterInput` input​

The filter conditions for this query.

#### `Database.checkCountSummary` ● `CheckCountSummary!` non-null object​

Get a check count summary.

##### `Database.checkCountSummary.filter` ● `CheckKind` enum​

#### `Database.checksRelay` ● `CheckConnection` object​

##### `Database.checksRelay.first` ● `Int` scalar​

##### `Database.checksRelay.after` ● `String` scalar​

##### `Database.checksRelay.where` ● `FilterInput` input​

##### `Database.checksRelay.order` ● `OrderInput` input​

#### `Database.customAttributes` ● `[CustomAttribute!]!` non-null object​

Custom attributes defined for this monitored system.

#### `Database.customData` ● `String` scalar​

Special data for this monitored system

#### `Database.customer` ● `Customer!` non-null object​

#### `Database.description` ● `String` scalar​

#### `Database.maintenance` ● `Boolean` scalar​

#### `Database.monitorOff` ● `Boolean` scalar​

#### `Database.monitorOffUntil` ● `DateTime` scalar​

#### `Database.monitorSwitchReason` ● `String` scalar​

#### `Database.monitorSwitchDate` ● `DateTime` scalar​

#### `Database.name` ● `String` scalar​

#### `Database.operational` ● `Boolean` scalar​

#### `Database.operationalSince` ● `Date` scalar​

#### `Database.operationalUntil` ● `Date` scalar​

#### `Database.status` ● `Status!` non-null enum​

The status of the monitored system

#### `Database.statusId` ● `Int!` non-null scalar​

The check status as number: 2 => CRITICAL 1 => WARNING 0 => OK -1 => UNKNOWN -2 => DISABLED

#### `Database.systemRole` ● `String` deprecated scalar​

DEPRECATED

Use the improved variant role that points to a SystemRole type.

The role of this system.

#### `Database.role` ● `SystemRole` object​

The role of this system.

#### `Database.type` ● `MonitoredSystemType!` non-null enum​

#### `Database.timestamp` ● `DateTime` scalar​

#### `Database.uuid` ● `String` scalar​

#### `Database.server` ● `Server` object​

The server this database is monitored on.

#### `Database.databaseType` ● `String!` non-null scalar​

The database type.

#### `Database.user` ● `UserPassword` deprecated object​

DEPRECATED

Only available in the standalone database

The credentials of the database user.

#### `Database.user2` ● `UserPassword` deprecated object​

DEPRECATED

Only available in the standalone database

The credentials of the 2nd database user.

#### `Database.attributes` ● `String` deprecated scalar​

DEPRECATED

Only available in the standalone database

Special attributes for the given database object.

#### `Database.actions` ● `[SystemAction!]!` non-null object​

Get all the possible system actions. They can be used with mutation executeSystemAction(...).

##### `Database.actions.actionType` ● `[SystemActionType!]` list enum​

#### `Database.performance` ● `MonitoredSystemPerformanceData` object​

This field holds information about the available performance resources for this monitored system.

#### `Database.version` ● `String` scalar​

The version of the underlying DMBS.

#### `Database.dbmsProduct` ● `String` scalar​

The DBMS production information.

#### `Database.administrator` ● `User` object​

Who is responsible as administrator for this system.

#### `Database.administratorDeputy` ● `User` object​

Who is responsible as administrator deputy for this system.

#### `Database.businessObjects` ● `[SapBusinessObject!]!` non-null object​

The list of connected SAP business objects.

#### `Database.remote` ● `Boolean!` non-null scalar​

Is this a remote system

#### `Database.info` ● `[InfoNode]` list object​

Information about this monitored system.

#### `Database.kind` ● `DatabaseKind!` non-null enum​

Database kind. Either Standalone or SAP system database

#### `Database.sapSystem` ● `SapSystem` object​

The associated SAP system for if this database is a SAP database. Will be null for standalone databases.

#### `Database.systemDatabase` ● `Database` object​

In case this is a SAP system database (see field: kind) based on HANA this points to the HANS system database.

#### `Database.applicationType` ● `String` scalar​

The application type of this monitored system.

#### `Database.assignedSLA` ● `ServiceLevelAgreement` object​

The assigned SLA (service level agreement).

#### `Database.monitorLevel` ● `MonitorLevel!` non-null enum​

The monitor level

#### `Database.credentialPurposes` ● `[CredentialsPurpose]!` non-null object​

Available credential purposes for this system.

#### `Database.credentials` ● `[CredentialsBase]!` non-null interface​

Available credentials for this system.

#### `Database.host` ● `String` scalar​

The host used to connect to the database.

#### `Database.port` ● `Int` scalar​

The port used to connect to the database.

#### `Database.notSeen` ● `Boolean` scalar​

Whether this system is "not seen". Not seen means the system was once seen on an agent but now it isn't.

#### `Database.notifications` ● `[Notification]!` non-null interface​

Associated notification actions

##### `Database.notifications.where` ● `FilterInput` input​

##### `Database.notifications.order` ● `OrderInput` input​

#### `Database.pagedNotifications` ● `NotificationPage!` non-null object​

The paged variant for the notification field.

##### `Database.pagedNotifications.pageRequest` ● `PageRequest!` non-null input​

##### `Database.pagedNotifications.where` ● `FilterInput` input​

##### `Database.pagedNotifications.order` ● `OrderInput` input​

#### `Database.settings` ● `DatabaseSettings` object​

If this is a standalone database the settings field contains the database setting.

#### `Database.dbType` ● `DatabaseType` object​

The database type. Use this to get the full info about a DB type.

#### `Database.managedStatus` ● `ManagedSystemStatus!` non-null enum​

Managed status for this system.

#### `Database.monitoringParametersGroups` ● `[MonitoringParameterGroup!]!` non-null object​

Monitoring parameter groups

#### `Database.monitoringParameterByName` ● `ValueParameter` object​

Query a single monitoring parameter by its name. Here is an example query: query MoniParams { servers { agentConnect: monitoringParameterByName(name: "AgentListenerPort") { id name values } agentEnv: monitoringParameterByName(name: "AgentEnvironment") { id name values } } }

##### `Database.monitoringParameterByName.name` ● `String!` non-null scalar​

#### `Database.draft` ● `Boolean!` non-null scalar​

Tells if a draft or a saved system.

#### `Database.application` ● `ApplicationType` object​

The application type for this monitored system.

#### `Database.changes` ● `[Change!]!` non-null object​

Changes for this monitored system.

##### `Database.changes.where` ● `FilterInput` input​

##### `Database.changes.order` ● `OrderInput` input​

#### `Database.pagedChanges` ● `ChangePage` object​

Paged changes for this monitored system.

##### `Database.pagedChanges.pageRequest` ● `PageRequest!` non-null input​

##### `Database.pagedChanges.where` ● `FilterInput` input​

##### `Database.pagedChanges.order` ● `OrderInput` input​

#### `Database.systemParameterSets` ● `[SystemParameterSet!]!` non-null object​

Returns all available system parameter sets.

### Interfaces​

#### `MonitoredSystem` interface​

Interface for a monitored system

### Returned By​

`database` query ● `databases` query ● `turnMonitoringOffForDatabase` mutation ● `turnMonitoringOnForDatabase` mutation

### Member Of​

`CreateDatabasePayload` object ● `Database` object ● `DatabasePage` object ● `SapBusinessObject` object ● `SapSystem` object ● `Server` object ● `UpdateDatabasePayload` object