Nextended.Aspire.Hosting.WebDataStudio — API reference

🇩🇪 Diese Seite auf Deutsch

The complete public surface of Nextended.Aspire.Hosting.WebDataStudio, generated from the compiled assembly.

Generated

This page is generated by tools/ApiRef from the compiled assembly — it includes members with no XML comment and therefore cannot drift from the code. Do not edit by hand.

↩ Back to the package page

Nextended.Aspire.Hosting.WebDataStudio

WebDataStudioAttachExtensions

static class

Attaches WebDataStudio to a database from the database's own side, the way Aspire's WithPgAdmin and WithRedisInsight do it: the studio is created once and every further call attaches another connection to the same one.

WebDataStudioBuilderExtensions

static class

Fluent API for running WebDataStudio inside your Aspire stack. Either add it yourself with AddWebDataStudio and attach databases with WithReference, or start from a database resource and call WithWebDataStudio``1.

WebDataStudioEngine

enum

The database engines WebDataStudio can talk to. The value tells the studio which driver to open a connection string with, and is passed as WDS_CONN_<NAME>_ENGINE.

Values

• ClickHouse
  ClickHouse.
• DuckDb
  DuckDB, backed by a file the container can reach.
• MongoDb
  MongoDB.
• MySql
  MySQL and MariaDB.
• Oracle
  Oracle Database.
• PostgreSql
  PostgreSQL (and anything speaking its wire protocol).
• Redis
  Redis and Valkey.
• SqlServer
  Microsoft SQL Server and Azure SQL.
• Sqlite
  SQLite, backed by a file the container can reach.
• value__

WebDataStudioEngineExtensions

static class

Maps WebDataStudioEngine to the identifiers WebDataStudio expects.

Extension methods

• ToEngineId(this WebDataStudioEngine engine) : string
  The engine id as WebDataStudio spells it in WDS_CONN_<NAME>_ENGINE.

WebDataStudioResource

class

WebDataStudio — a browser-based database studio — running as a container resource. Exposes an HTTP endpoint for the studio, and carries the connections that were attached to it so several databases can share one instance.

Constructors

• WebDataStudioResource(string name)
  WebDataStudio — a browser-based database studio — running as a container resource. Exposes an HTTP endpoint for the studio, and carries the connections that were attached to it so several databases can share one instance.

Properties

• ConnectionNames : IReadOnlyList<string> { get; }
  Names of the connections attached to this studio, in the order they were added. These are the labels the studio shows in its explorer, and the suffixes of its WDS_CONN_* variables.
• Title : string { get; }
  The name the studio shows in its header and browser tab. Defaults to the resource name, so three studios in one stack are told apart at a glance; WithTitle overrides it and WithTitle(null) leaves the studio unnamed.
• Username : string { get; }
  Login name, when one was configured with WithLogin. Null means anonymous access.

Fields

• DefaultImage : string
  The published WebDataStudio image.
• DefaultResourceName : string
  Resource name used when nothing else is asked for, and the key for sharing one studio.
• DefaultTag : string
  Default image tag.
• DefaultTargetPort : int
  Port the studio listens on inside the container.
• HttpEndpointName : string
  Name of the HTTP endpoint serving the studio.

Projects

Nextended_Aspire_Hosting_WebDataStudio

class

Metadata for the Aspire AppHost project.

Properties

• ProjectPath : string { get; }
  The path to the Aspire Host project.

↩ Back to the package page