Nebula
Core

DatabaseUrl

Where the orchestrator keeps the control plane and saved entities, as one string (NebulaConfig.DatabaseUrl, -nebula-database).

generated from the sources
public readonly struct DatabaseUrl

Where the orchestrator keeps the control plane and saved entities, as one string (NebulaConfig.DatabaseUrl, -nebula-database).

  • sqlite:<file>: a SQLite database file (standalone orchestrator; the default for a local mesh).
  • postgres://user:password@host:port/database (or postgresql://, or a Host=...; connection string): a PostgreSQL database (standalone orchestrator; for a deployed mesh).
  • file:<folder>: plain files in a folder (the Unity orchestrator, which carries no database driver).
  • memory: nothing survives the process.

Fields

Scheme

public readonly string Scheme;

sqlite, postgres, file or memory.

Target

public readonly string Target;

The file, folder or connection string the scheme applies to ("" for memory).

Display

public readonly string Display;

What was parsed, for logs, with a password masked.

Methods

Parse

public static DatabaseUrl Parse(string url, string fallback);
ParameterDescription
urlThe configured value; empty or null means fallback.
fallbackWhat an empty value means for this process, e.g. sqlite:/opt/nebula/data/nebula.db.

Throws ArgumentException: The value has no scheme this build understands.

ToString

public override string ToString();

On this page