TimescaleDB / Tiger Data · Schema

ForkServiceCreate

Create a fork of an existing service. Service type, region code, and storage are always inherited from the parent service. HA replica count is always set to 0 for forked services.

DatabaseTime-SeriesPostgreSQLOpen SourceCloudHypertablesContinuous AggregatesTiger Cloud

Properties

Name Type Description
name string A human-readable name for the forked service. If not provided, will use parent service name with "-fork" suffix.
cpu_millis string The initial CPU allocation in milli-cores, or 'shared' for a shared-resource service. If not provided, will inherit from parent service.
memory_gbs string The initial memory allocation in gigabytes, or 'shared' for a shared-resource service. If not provided, will inherit from parent service.
fork_strategy object Strategy for creating the fork. This field is required.
target_time string Target time for point-in-time recovery. Required when fork_strategy is PITR.
environment_tag object The environment tag for the forked service, 'DEV' by default.
View JSON Schema on GitHub

JSON Schema

timescaledb-forkservicecreate-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ForkServiceCreate",
  "title": "ForkServiceCreate",
  "type": "object",
  "required": [
    "fork_strategy"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "A human-readable name for the forked service. If not provided, will use parent service name with \"-fork\" suffix.",
      "example": "my-production-db-fork"
    },
    "cpu_millis": {
      "type": "string",
      "description": "The initial CPU allocation in milli-cores, or 'shared' for a shared-resource service. If not provided, will inherit from parent service.",
      "example": "1000"
    },
    "memory_gbs": {
      "type": "string",
      "description": "The initial memory allocation in gigabytes, or 'shared' for a shared-resource service. If not provided, will inherit from parent service.",
      "example": "4"
    },
    "fork_strategy": {
      "$ref": "#/components/schemas/ForkStrategy",
      "description": "Strategy for creating the fork. This field is required."
    },
    "target_time": {
      "type": "string",
      "format": "date-time",
      "description": "Target time for point-in-time recovery. Required when fork_strategy is PITR.",
      "example": "2024-01-01T00:00:00Z"
    },
    "environment_tag": {
      "$ref": "#/components/schemas/EnvironmentTag",
      "description": "The environment tag for the forked service, 'DEV' by default.",
      "default": "DEV"
    }
  },
  "description": "Create a fork of an existing service. Service type, region code, and storage are always inherited from the parent service.\nHA replica count is always set to 0 for forked services.\n"
}