@deepbrainspace/nx-surrealdb/src/generators/init/schema.json

NX plugin for SurrealDB migrations with modular architecture

{
  "$schema": "https://json-schema.org/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the database project (will be used as namespace)",
      "default": "database",
      "$default": {
        "$source": "argv",
        "index": 0
      }
    },
    "path": {
      "type": "string",
      "description": "Base directory where the project will be created",
      "default": "."
    },
    "db-path": {
      "type": "string",
      "description": "Database folder name within the project",
      "default": ""
    },
    "url": {
      "type": "string",
      "description": "SurrealDB connection URL",
      "default": "ws://localhost:8000/rpc"
    },
    "namespace": {
      "type": "string",
      "description": "SurrealDB namespace (auto-derived from project name if not specified)"
    },
    "environments": {
      "type": "string",
      "description": "Comma-separated list of environment databases to create",
      "default": "development,staging,production"
    },
    "database": {
      "type": "string",
      "description": "SurrealDB database name",
      "default": "main"
    },
    "user": {
      "type": "string",
      "description": "SurrealDB root user",
      "default": "root"
    },
    "pass": {
      "type": "string",
      "description": "SurrealDB root password",
      "default": "root"
    }
  },
  "required": ["name"]
}