:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
from typing import Optional, cast
from products.warehouse_sources.sources.lightdash._config import LightdashSourceConfig
from products.warehouse_sources.sources.lightdash.lightdash import (
HOST_NOT_ALLOWED_ERROR,
lightdash_source,
validate_credentials as validate_lightdash_credentials,
)
from products.warehouse_sources.sources.lightdash.settings import ENDPOINTS, INCREMENTAL_FIELDS
from products.warehouse_sources.sources.sdk import (
CanonicalDescriptions,
DataWarehouseSourceCategory,
ExternalDataSourceType,
FieldType,
ReleaseStatus,
SimpleSource,
SourceConfig,
SourceFieldInputConfig,
SourceFieldInputConfigType,
SourceInputs,
SourceRegistry,
SourceResponse,
SourceSchema,
build_endpoint_schemas,
detect,
)
@SourceRegistry.register
class LightdashSource(SimpleSource[LightdashSourceConfig]):
codebase_detection = detect(env=("^LIGHTDASH_",), npm=("@lightdash/cli", "@lightdash/sdk"), pypi=("lightdash",))
# `get_schemas` iterates a static endpoint catalog with no I/O, so the table list is safe to
# render in public docs without credentials.
lists_tables_without_credentials = True
api_docs_url = "https://docs.lightdash.com/api-reference/v1/introduction"
@property
def source_type(self) -> ExternalDataSourceType:
return ExternalDataSourceType.LIGHTDASH
@property
def connection_host_fields(self) -> list[str]:
# `instance_url` determines which host the stored personal access token is sent to;
# retargeting it must force the editor to re-enter the token.
return ["instance_url"]
def get_non_retryable_errors(self) -> dict[str, str | None]:
return {
"401 Client Error": "Lightdash rejected your personal access token. Generate a new token in your user settings and reconnect.",
"403 Client Error": "Your Lightdash personal access token does not have permission to read this data. Check the token owner's project access and reconnect.",
HOST_NOT_ALLOWED_ERROR: "The Lightdash instance URL is not allowed. Please use your instance's public URL.",
}
def get_canonical_descriptions(self) -> CanonicalDescriptions:
from products.warehouse_sources.sources.lightdash.canonical_descriptions import CANONICAL_DESCRIPTIONS
return CANONICAL_DESCRIPTIONS
def get_schemas(
self,
config: LightdashSourceConfig,
team_id: int,
with_counts: bool = False,
names: list[str] | None = None,
force_refresh: bool = False,
api_version: str | None = None,
) -> list[SourceSchema]:
# Appending would add a copy of every run in the API's rolling 7-day window on each sync.
return build_endpoint_schemas(ENDPOINTS, INCREMENTAL_FIELDS, names, merge_only=["scheduler_runs"])
def validate_credentials(
self,
config: LightdashSourceConfig,
team_id: int,
schema_name: Optional[str] = None,
api_version: str | None = None,
) -> tuple[bool, str | None]:
return validate_lightdash_credentials(
instance_url=config.instance_url,
api_token=config.api_token,
team_id=team_id,
schema_name=schema_name,
)
def source_for_pipeline(self, config: LightdashSourceConfig, inputs: SourceInputs) -> SourceResponse:
return lightdash_source(
instance_url=config.instance_url,
api_token=config.api_token,
endpoint=inputs.schema_name,
team_id=inputs.team_id,
job_id=inputs.job_id,
)
@property
def get_source_config(self) -> SourceConfig:
return SourceConfig(
name=ExternalDataSourceType.LIGHTDASH,
category=DataWarehouseSourceCategory.ANALYTICS,
label="Lightdash",
caption=(
"Connect Lightdash with a **personal access token**, created under "
"**Settings → Personal access tokens**. Enter the URL of your Lightdash instance "
"(Lightdash Cloud, e.g. `https://app.lightdash.cloud`, or your self-hosted domain). "
"The token inherits its owner's project access, so use a token from a user with "
"access to every project you want to sync."
),
docsUrl="https://posthog.com/docs/cdp/sources/lightdash",
iconPath="/static/services/lightdash.png",
keywords=["bi", "dashboards", "analytics"],
fields=cast(
list[FieldType],
[
SourceFieldInputConfig(
name="instance_url",
label="Instance URL",
type=SourceFieldInputConfigType.TEXT,
required=True,
placeholder="https://app.lightdash.cloud",
secret=False,
),
SourceFieldInputConfig(
name="api_token",
label="Personal access token",
type=SourceFieldInputConfigType.PASSWORD,
required=True,
placeholder="",
secret=True,
),
],
),
releaseStatus=ReleaseStatus.BETA,
)