OBJECT

MssqlDatabase

Description

SQL Server database.

link GraphQL Schema definition

  • type MssqlDatabase implements HierarchyObject, CdmHierarchyObject, HierarchySnappable, CdmHierarchySnappableNew, MssqlTopLevelDescendantType, PhysicalHostDescendantType, WindowsClusterDescendantType, MssqlAvailabilityGroupDescendantType, MssqlAvailabilityGroupLogicalChildType, MssqlInstanceDescendantType, MssqlInstanceLogicalChildType, MssqlHostDescendantType {
  • # CDM ID of the SQL Server database.
  • cdmId: String!
  • # Specifies if the SQL Server database is a relic.
  • isRelic: Boolean!
  • # Specifies if the SQL Server database is a live mount.
  • isMount: Boolean!
  • # Specifies if the SQL Server database is a log shipping secondary.
  • isLogShippingSecondary: Boolean!
  • # List of reasons that a SQL Server database cannot be protected.
  • unprotectableReasons: [String!]!
  • # Specifies whether the the Rubrik Backup Service has permission to back up a SQL
  • # Server database.
  • hasPermissions: Boolean!
  • # Specifies if the SQL Server database is online.
  • isOnline: Boolean!
  • # Specifies if the SQL Server database is in an availability group.
  • isInAvailabilityGroup: Boolean!
  • # Specifies if the recovery model is simple, full, or bulk-logged.
  • recoveryModel: String!
  • # List of the replicas available for the SQL Server database.
  • replicas: [CdmMssqlDbReplica!]!
  • # Information about the script run before a backup.
  • preBackupScript: String!
  • # Information about the script run after a backup.
  • postBackupScript: String!
  • # Specifies if copy-only backups are enabled. When false, database backups are
  • # full backups.
  • copyOnly: Boolean!
  • # Number of seconds between two log backups. When the value is set to 0, log
  • # backups are not enabled. When the value is set to -1, the default log backup
  • # frequency of the Rubrik cluster is used. When the value is set to -2, the log
  • # backup frequency is derived from the SLA Domain.
  • logBackupFrequencyInSeconds: Float!
  • # Number of hours to retain a log backup. When the value is set to -1, the Rubrik
  • # cluster retains the log backup until the database snapshots that precede the log
  • # backup have expired. When the value is set to -2, the default log backup
  • # retention of the Rubrik cluster is used. When the value is set to -3, the log
  • # backup retention is derived from the SLA Domain.
  • logBackupRetentionInHours: Int!
  • # Interval, in seconds, between the deletion of archived log files whose
  • # 'nextTime' field specifies a time longer than this interval. To specify an
  • # interval, enter a positive integer. To immediately delete archived log files
  • # regardless of age, specify an interval of -1. To preserve all archived log
  • # files, specify an interval of -2.
  • hostLogRetention: Long!
  • # Boolean flag indicating if the database derives log backup configurations from
  • # SLA.
  • hasLogConfigFromSla: Boolean!
  • # ID of the associated SQL Server distributed availability group object.
  • dagId: UUID!
  • # The list of snapshots taken for a SQL Server database.
  • #
  • # Arguments
  • # first: Returns the first n elements from the list.
  • # after: Returns the elements in the list that occur after the
  • # specified cursor.
  • # sortOrder: Sorts the order of results.
  • # CdmSnapshotFilter: Filter CDM snapshots.
  • # sortBy: Sorts snapshots by field.
  • cdmSnapshots(
  • first: Int,
  • after: String,
  • sortOrder: SortOrder,
  • CdmSnapshotFilter: [CdmSnapshotFilter!],
  • sortBy: CdmSnapshotSortByEnum
  • ): CdmWorkloadSnapshotConnection!
  • # The count of on demand snapshots for a SQL Server database.
  • cdmOnDemandSnapshotCount: Int!
  • # List of live mounts for a SQL Server database.
  • #
  • # Arguments
  • # first: Returns the first n elements from the list.
  • # after: Returns the elements in the list that occur after the
  • # specified cursor.
  • # sortBy: Sort by argument for Mssql database live mounts.
  • # filters: Filters for Mssql database live mounts.
  • liveMounts(
  • first: Int,
  • after: String,
  • sortBy: MssqlDatabaseLiveMountSortByInput,
  • filters: [MssqlDatabaseLiveMountFilterInput!]
  • ): MssqlDatabaseLiveMountConnection!
  • # List of snapshots taken for a Rubrik CDM workload grouped by attributes.
  • #
  • # Arguments
  • # first: Returns the first n elements from the list.
  • # after: Returns the elements in the list that occur after the
  • # specified cursor.
  • # sortOrder: Sorts the order of results.
  • # CdmSnapshotFilter: Filter CDM snapshots.
  • # sortBy: Sorts snapshots by field.
  • # groupBy: Groups snapshots by field.
  • # timezoneOffset: Offset based on customer timezone.
  • cdmGroupedSnapshots(
  • first: Int,
  • after: String,
  • sortOrder: SortOrder,
  • CdmSnapshotFilter: [CdmSnapshotFilter!],
  • sortBy: CdmSnapshotSortByEnum,
  • groupBy: CdmSnapshotGroupByEnum!,
  • timezoneOffset: Float
  • ): CdmGroupedSnapshotConnection!
  • # The oldest snapshot taken for a CDM workload.
  • cdmOldestSnapshot: CdmWorkloadSnapshot
  • # The newest snapshot taken for a CDM workload.
  • cdmNewestSnapshot: CdmWorkloadSnapshot
  • # FID of the hierarchy object.
  • id: UUID!
  • # Name of the hierarchy object.
  • name: String!
  • # Type of this object.
  • objectType: HierarchyObjectTypeEnum!
  • # SLA Domain assignment type for this object.
  • slaAssignment: SlaAssignmentTypeEnum!
  • # Effective SLA Domain of the hierarchy object.
  • effectiveSlaDomain: SlaDomain!
  • # Pause status of the effective SLA Domain of the hierarchy object.
  • slaPauseStatus: Boolean!
  • # Distribution of the snapshots of the hierarchy object.
  • snapshotDistribution: SnapshotDistribution!
  • # Effective retention of the SLA Domain of the hierarchy object.
  • effectiveRetentionSlaDomain: SlaDomain
  • # SLA Domain configured for the hierarchy object.
  • configuredSlaDomain: SlaDomain!
  • # Path node of the effective SLA Domain source.
  • effectiveSlaSourceObject: PathNode
  • # Sequential list of this object's logical ancestors.
  • logicalPath: [PathNode!]!
  • # Sequential list of this object's physical ancestors.
  • physicalPath: [PathNode!]!
  • # Number of descendant workloads of this object.
  • numWorkloadDescendants: Int!
  • # Organizations to which this hierarchy object belongs.
  • allOrgs: [Org!]!
  • # Security posture metadata.
  • securityMetadata: SecurityMetadata
  • # Rubrik cluster where this object originated.
  • cluster: Cluster!
  • # The source cluster of this object. Returned as a data location because there is
  • # no guarantee that Rubrik has knowledge about the source cluster.
  • primaryClusterLocation: DataLocation!
  • # SLA Domain assignment of the object during the process of being communicated
  • # over to Rubrik CDM.
  • pendingSla: SlaDomain
  • # Mapping from object ID to pending object deletion status.
  • pendingObjectDeletionStatus: PendingSnapshotsOfObjectDeletion
  • # Objects either replicated by this object or related to this object by
  • # replication.
  • replicatedObjects: [CdmHierarchyObject!]!
  • # Cross-account objects either replicated by this object or related to this object
  • # by replication.
  • crossAccountReplicatedObjectInfos: [CrossAccountReplicatedObjectInfo!]
  • # Latest user note information.
  • latestUserNote: LatestUserNote
  • # The number of objects either replicated by this object or related to this object
  • # by replication.
  • replicatedObjectCount: Int!
  • # The authorized operations on the object.
  • authorizedOperations: [Operation!]!
  • # A link to view the workload on the CDM cluster. For dev use only.
  • cdmLink: String!
  • # The list of missed snapshots for this workload.
  • #
  • # Arguments
  • # first: Returns the first n elements from the list.
  • # after: Returns the elements in the list that occur after the
  • # specified cursor.
  • # filter: Filter missed snapshots by date.
  • missedSnapshotConnection(
  • first: Int,
  • after: String,
  • filter: MissedSnapshotFilterInput
  • ): MissedSnapshotCommonConnection
  • # The list of missed snapshots for this workload.
  • #
  • # Arguments
  • # first: Returns the first n elements from the list.
  • # after: Returns the elements in the list that occur after the
  • # specified cursor.
  • # last: Returns the last n elements from the list.
  • # before: Returns the elements in the list that occur before the
  • # specified cursor.
  • # filter: Filter missed snapshots by date.
  • # groupBy: Group snapshots by field.
  • # timezoneOffset: Offset based on customer timezone.
  • missedSnapshotGroupByConnection(
  • first: Int,
  • after: String,
  • last: Int,
  • before: String,
  • filter: MissedSnapshotFilterInput,
  • groupBy: MissedSnapshotGroupByTime!,
  • timezoneOffset: Float
  • ): MissedSnapshotGroupByConnection
  • # The list of snapshots taken for this workload.
  • #
  • # Arguments
  • # first: Returns the first n elements from the list.
  • # after: Returns the elements in the list that occur after the
  • # specified cursor.
  • # last: Returns the last n elements from the list.
  • # before: Returns the elements in the list that occur before the
  • # specified cursor.
  • # filter: Filter snapshot connection.
  • # sortBy: Sorts snapshots by field.
  • # sortOrder: Sorts the order of results.
  • snapshotConnection(
  • first: Int,
  • after: String,
  • last: Int,
  • before: String,
  • filter: CdmSnapshotFilterInput,
  • sortBy: CdmSnapshotSortByEnum,
  • sortOrder: SortOrder
  • ): CdmSnapshotConnection
  • # GroupBy connection for the snapshots of this workload.
  • #
  • # Arguments
  • # first: Returns the first n elements from the list.
  • # after: Returns the elements in the list that occur after the
  • # specified cursor.
  • # last: Returns the last n elements from the list.
  • # before: Returns the elements in the list that occur before the
  • # specified cursor.
  • # timezoneOffset: Offset based on customer timezone.
  • # filter: Filter snapshot connection.
  • # groupBy: Groups snapshots by field.
  • # timezone: Time zone identifier string. For example,
  • # 'America/Los_Angeles' is used for the U.S. Pacific Time zone.
  • snapshotGroupByConnection(
  • first: Int,
  • after: String,
  • last: Int,
  • before: String,
  • timezoneOffset: Float,
  • filter: CdmSnapshotFilterInput,
  • groupBy: CdmSnapshotGroupByEnum!,
  • timezone: Timezone
  • ): CdmSnapshotGroupByConnection
  • # GroupBy connection for the snapshots of this workload.
  • #
  • # Arguments
  • # first: Returns the first n elements from the list.
  • # after: Returns the elements in the list that occur after the
  • # specified cursor.
  • # last: Returns the last n elements from the list.
  • # before: Returns the elements in the list that occur before the
  • # specified cursor.
  • # timezoneOffset: Offset based on customer timezone.
  • # timezone: Time zone identifier string. For example,
  • # 'America/Los_Angeles' is used for the U.S. Pacific Time zone.
  • # filter: Filter snapshot connection.
  • # groupBy: Groups snapshots by field.
  • snapshotGroupBySummary(
  • first: Int,
  • after: String,
  • last: Int,
  • before: String,
  • timezoneOffset: Float,
  • timezone: Timezone,
  • filter: CdmSnapshotFilterInput,
  • groupBy: CdmSnapshotGroupByEnum!
  • ): CdmSnapshotGroupBySummaryConnection
  • # The most recent indexed snapshot of this workload.
  • newestIndexedSnapshot: CdmSnapshot
  • # The most recent snapshot of this workload.
  • #
  • # Arguments
  • # beforeTime: Specifies the time at which or before the snapshot
  • # was taken.
  • newestSnapshot(beforeTime: DateTime): CdmSnapshot
  • # The oldest snapshot of this workload.
  • oldestSnapshot: CdmSnapshot
  • # The number of on-demand snapshots.
  • onDemandSnapshotCount: Int!
  • # The newest snapshot archived to AWS.
  • newestArchivedSnapshot: CdmSnapshot
  • # The newest snapshot replicated to a cluster.
  • newestReplicatedSnapshot: CdmSnapshot
  • }