PostgresInstallation

Namespace: Ankus.PgConfig

Assembly: Ankus.PgConfig.dll

Describes one PostgreSQL installation by querying its authoritative pg_config executable.

public sealed class PostgresInstallation

Inheritance: object

Properties

BinDirectory

Gets the installation directory containing PostgreSQL executables.

public string BinDirectory { get; }

Value: string

CreateDbPath

Gets the platform-correct path to PostgreSQL’s createdb executable.

public string CreateDbPath { get; }

Value: string

DropDbPath

Gets the platform-correct path to PostgreSQL’s dropdb executable.

public string DropDbPath { get; }

Value: string

IncludeDirectory

Gets the public header directory, including dependencies of the server headers.

public string IncludeDirectory { get; }

Value: string

InitDbPath

Gets the platform-correct path to PostgreSQL’s initdb executable.

public string InitDbPath { get; }

Value: string

Label

Gets the Ankus version selector for this installation, such as pg18.

public string Label { get; }

Value: string

LibraryDirectory

Gets PostgreSQL’s native extension library directory.

public string LibraryDirectory { get; }

Value: string

PgConfigPath

Gets the absolute path to pg_config.

public string PgConfigPath { get; }

Value: string

PgCtlPath

Gets the platform-correct path to PostgreSQL’s pg_ctl executable.

public string PgCtlPath { get; }

Value: string

PreprocessorArguments

Gets the preprocessor arguments reported by this installation, split without shell expansion.

public IReadOnlyList<string> PreprocessorArguments { get; }

Value: IReadOnlyList<string>

PreprocessorFlags

Gets the preprocessor arguments reported by this installation’s build configuration.

public string PreprocessorFlags { get; }

Value: string

PsqlPath

Gets the platform-correct path to PostgreSQL’s psql executable.

public string PsqlPath { get; }

Value: string

ServerIncludeDirectory

Gets the server header directory for compiling native extension boundaries against this installation.

public string ServerIncludeDirectory { get; }

Value: string

SharedDirectory

Gets PostgreSQL’s architecture-independent shared-data directory.

public string SharedDirectory { get; }

Value: string

TargetInfo

Gets the exported information this installation was read from, or null for an installation on this machine.

public PostgresTargetInfo? TargetInfo { get; }

Value: PostgresTargetInfo

Such an installation can supply headers and build values to compile and package an extension, but has no executables or server on this machine.

Version

Gets the PostgreSQL version reported by this installation.

public PostgresVersion Version { get; }

Value: PostgresVersion

Methods

CreateAsync(string, CancellationToken)

Creates an installation descriptor by querying an explicit pg_config executable, or by reading exported target information.

public static Task<PostgresInstallation> CreateAsync(string pgConfigPath, CancellationToken cancellationToken = default)

Parameters:

pgConfigPath — string

Path to pg_config, or to an extracted ManifestFileName.

cancellationToken — CancellationToken

Cancels pg_config queries.

Returns: Task<PostgresInstallation>

The queried PostgreSQL installation.

DiscoverAsync(int, string?, CancellationToken)

Discovers a specific PostgreSQL major using an explicit Ankus home for registrations and managed installations. An unregistered installation without its server headers, such as one from a client-only package, is skipped.

public static Task<PostgresInstallation> DiscoverAsync(int major, string? homeDirectory, CancellationToken cancellationToken)

Parameters:

major — int

The required PostgreSQL major version.

homeDirectory — string

The selected home, or null to use ANKUS_HOME and the ordinary default.

cancellationToken — CancellationToken

Cancels installation queries.

Returns: Task<PostgresInstallation>

The registered installation or the first matching discovery candidate.

DiscoverAsync(int, CancellationToken)

Discovers a specific PostgreSQL major without requiring environment variables. Nonstandard installations can be registered as pgXX paths in the Ankus home’s config.json. ANKUS_HOME selects that home, defaulting to ~/.ankus.

public static Task<PostgresInstallation> DiscoverAsync(int major, CancellationToken cancellationToken = default)

Parameters:

major — int

The required PostgreSQL major version.

cancellationToken — CancellationToken

Cancels installation queries.

Returns: Task<PostgresInstallation>

The first matching installation in discovery order.

DiscoverAsync(CancellationToken)

Discovers PostgreSQL 18 from persisted configuration, managed installations, PATH, and platform installation locations.

public static Task<PostgresInstallation> DiscoverAsync(CancellationToken cancellationToken = default)

Parameters:

cancellationToken — CancellationToken

Cancels pg_config queries.

Returns: Task<PostgresInstallation>

The discovered PostgreSQL installation.

GetPreprocessorArgumentsAsync(CancellationToken)

Resolves preprocessor arguments for native compilation on the current platform.

public Task<IReadOnlyList<string>> GetPreprocessorArgumentsAsync(CancellationToken cancellationToken = default)

Parameters:

cancellationToken — CancellationToken

Cancels native SDK discovery.

Returns: Task<IReadOnlyList<string>>

PostgreSQL’s arguments with the active macOS SDK selected when compiling on macOS.

Exceptions:

• DirectoryNotFoundException: An explicit macOS SDK path does not identify an installed directory.

On macOS, SDKROOT selects an absolute installed SDK path; otherwise the active Apple developer tools select it. Historical SDK roots from PostgreSQL’s build machine are replaced. Other arguments and the recorded properties remain unchanged.

GetRegressionDriverPathAsync(CancellationToken)

Locates this installation’s PostgreSQL regression driver in its PGXS tree or Windows executable directory. Ordinary installation discovery does not require the regression tools to be installed.

public Task<string> GetRegressionDriverPathAsync(CancellationToken cancellationToken = default)

Parameters:

cancellationToken — CancellationToken

Cancels the PGXS query.

Returns: Task<string>

The absolute path to the installed pg_regress executable.

Exceptions:

• FileNotFoundException: The selected installation does not contain its regression driver.

On Windows, include this installation’s BinDirectory in the child process PATH so the driver can load its PostgreSQL DLLs.

GetValgrindSuppressionsPathAsync(CancellationToken)

Locates PostgreSQL’s Valgrind suppressions for this installation, which Valgrind startup passes to Memcheck as pgrx does when it keeps the PostgreSQL source tree.

public Task<string?> GetValgrindSuppressionsPathAsync(CancellationToken cancellationToken = default)

Parameters:

cancellationToken — CancellationToken

Cancels the PGXS query.

Returns: Task<string>

The src/tools/valgrind.supp file that ankus init installs in the PGXS tree, else the one in the source tree that PGXS records as abs_top_srcdir when it still exists, else null.