Back to All

June, 2023

11 months ago by ReadMe API

The June 2023 release of the Data Bridge API introduces database archiving and updates to support the release of v23 of Moody's RMS DLM models.

Data Bridge

Data Bridge servers are now deployed with v23 of the Moody's RMS Geohazard databases.

As with previous releases, v23 of the Geohazard database consumes space on each Data Bridge server instance. Each Data Bridge SQL server instance must have at least 50GB of free space in order to allow to updated database to be deployed. Once installed, the Geohazard database should be under 25GB in size. For tenants with multiple Data Bridge servers, the Geohazard database is deployed on each Data Bridge server.

  • Database name: RMS_GEOHAZARD_V230
  • Database size: 25GB
  • Free space required on the server: 50GB

Databases

The Export database to URI resource (POST /databridge/v1/sql-instances/{instanceName}/export) exports the specified database from a managed server instance as an MDF, BAK, or DACPAC database artifact.

This resource now supports an optional detachOnly parameter that enables faster exports of databases to the MDF file format. If true, the database is merely taken offline for the duration of the export job and not backed up. If the detachOnly parameter is undefined or set to false, the database is backed up before it is detached.

The detachOnly parameter must must be set to true if a database larger than 100GB is exported as an MDF database artifact. If this parameter is not set to true, the API returns a 400 response.

Archives

Data Bridge introduces a new collection of API resources that enable tenants to manage archived copies of databases they have deleted from managed SQL Server instances.

Whenever a client deletes a database hosted on a managed SQL Server instance, Data Bridge automatically stashes an archive of that database (both as a MDF database artifact and LDF transaction log) on AWS S3. Unlike exported databases --which by default stores a database on AWS S3 for 7 days, archived databases are stored for 90 days.

Resources in the Archives collection enable the client to view information about, restore, and delete archived databases. To perform these operations, a principal must belong to a group that has been assigned Data Bridge Admin role-based permissions.

The collection consists of four resources:

The Get archives by server instance (GET /v1/sql-instances/{instanceName}/Archives resource returns a list of the archived databases for the specified managed SQL Server instance. The endpoint accepts the name of the server instance as a path parameter. For each archived database, the resource returns an archiveId, serverName, name, sizeInMb, createDate, expiryDate, and createdBy.

The Get archive (GET /v1/sql-instances/{instanceName}/Archives/{archiveId} resource returns information about a specific archived database. The endpoint accepts the name of the server instance and the ID of the archive as path parameters. The resource returns an archiveId, serverName, name, sizeInMb, createDate, expiryDate, createdBy, and downloadUris. The downloadUris attribute contains links to MDF and LDF files for the archived database.

The Delete archive resource (DELETE /v1/sql-instances/{instanceName}/Archives/{archiveId} deletes the specified archive. The endpoint accepts the name of the server instance and the ID of the archive as path parameters.

The Restore archive (POST /v1/sql-instances/Archives/{archiveId}/restore resource restores the specified archive to the specified managed SQL Server instance. The resource accepts the name of the server instance and the ID of the archive as path parameters and requires that the databaseName is specified in the request body. Clients may also optionally specify a targetInstance and owner in the request body.