Blaze FHIR Server
main - ci-build

Blaze FHIR Server - Local Development build (vmain) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Compact a Database Column Family - JSON Representation

Active as of 2026-11-22

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "compact",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition compact</b></p><a name=\"compact\"> </a><a name=\"hccompact\"> </a><p>URL: [base]/$compact</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>database</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-Database.html\">Database Value Set</a> (Required)</td><td><div><p>The name of the database holding the column family.</p>\n</div></td></tr><tr><td>IN</td><td>column-family</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-ColumnFamily.html\">Column Family Value Set</a> (Required)</td><td><div><p>The name of the column family to compact. Which column families exist depends on the database.</p>\n</div></td></tr></table></div>"
  },
  "url" : "https://blaze-server.org/fhir/OperationDefinition/compact",
  "version" : "main",
  "name" : "Compact",
  "title" : "Compact a Database Column Family",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-11-22T10:48:55+00:00",
  "publisher" : "The Samply Community",
  "contact" : [
    {
      "name" : "The Samply Community",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://samply.de"
        }
      ]
    }
  ],
  "description" : "Compacts a column family of one of the RocksDB databases of Blaze. RocksDB compacts automatically, but in certain situations a manual compaction can be useful. The response is always async according to the Asynchronous Interaction Request Pattern. The progress is also available from the underlying CompactJob Task resource.",
  "affectsState" : true,
  "code" : "compact",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "database",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The name of the database holding the column family.",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "https://blaze-server.org/fhir/ValueSet/Database"
      }
    },
    {
      "name" : "column-family",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The name of the column family to compact. Which column families exist depends on the database.",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "https://blaze-server.org/fhir/ValueSet/ColumnFamily"
      }
    }
  ]
}