Type Alias ConnectOptions

Type Declaration

• ConnectOptionsBase & {
      driver: string;
      databaseOptions?: Record<string, string>;
  }

  • driver: string

    Driver to load. Accepts any of the following forms:

    • Short name: "sqlite", "postgresql" — the driver manager searches for a matching manifest file (e.g. sqlite.toml) in the configured directories, then falls back to LD_LIBRARY_PATH / PATH.
    • Absolute path to a shared library: "/usr/lib/libadbc_driver_sqlite.so"
    • Absolute path to a driver manifest .toml file (with or without the .toml extension).
    • Relative path (only valid when LoadFlags.AllowRelativePaths is set).
    • URI-style string: "sqlite:file::memory:", "postgresql://user:pass@host/db" — the driver name is the URI scheme and the remainder is passed as the connection URI.
    • Connection profile URI: "profile://my_profile" — loads a named profile from a .toml file found in profileSearchPaths or the default search directories.

  • OptionaldatabaseOptions?: Record<string, string>

    Database-specific options passed to the driver during initialization.

• ConnectOptionsBase & {
      databaseOptions: ({ uri: string } | { profile: string }) & Record<
          string,
          string,
      >;
  }

  • databaseOptions: ({ uri: string } | { profile: string }) & Record<string, string>

    Database-specific options passed to the driver during initialization.

    When driver is omitted, either uri or profile is required:

    • uri — passed directly to the driver manager (e.g. "sqlite::memory:", "profile://name")
    • profile — bare connection profile name; the profile file specifies the driver