API Reference¶

Complete API reference for all Kedro-Dagster classes and functions. Use the search box to filter, or click any name to see full documentation.

The API is organized by module:

Translators (translator, catalog, nodes, pipelines, kedro): convert Kedro projects into Dagster definitions
Creators (dagster): build Dagster executors, schedules, and loggers from configuration
Datasets (datasets): custom dataset types for Dagster partitions and Nothing-typed assets
Configuration (config): Pydantic models for dagster.yml sections (jobs, executors, schedules, loggers)
Logging (logging): unified Kedro/Dagster logger and formatters
CLI (cli): kedro dagster command implementations
Utilities (utils): naming, formatting, and helper functions used internally

Name	Type	Module	Description
`CatalogTranslator`	Class	kedro_dagster.catalog	Translate Kedro datasets into Dagster IO managers.
`CeleryDockerExecutorOptions`	Class	kedro_dagster.config	Options for the Celery-based executor which launches tasks as Docker containers.
`CeleryExecutorOptions`	Class	kedro_dagster.config	Options for the Celery-based executor.
`CeleryK8sJobExecutorOptions`	Class	kedro_dagster.config	Options for the Celery-based executor which launches tasks as Kubernetes jobs.
`CliContext`	Class	kedro_dagster.utils	Runtime context passed to CLI command handlers.
`commands`	Function	kedro_dagster.cli	Top-level Kedro-Dagster CLI group.
`dagster_colored_formatter`	Function	kedro_dagster.logging	Create a colored formatter for Dagster logging using coloredlogs.
`dagster_commands`	Function	kedro_dagster.cli	Run project with Dagster.
`dagster_json_formatter`	Function	kedro_dagster.logging	Create a JSON formatter for Dagster logging.
`dagster_rich_formatter`	Function	kedro_dagster.logging	Create a rich console formatter for Dagster logging.
`DagsterCodeLocation`	Class	kedro_dagster.translator	A typed container for all artifacts that make up a Dagster code location.
`DagsterNothingDataset`	Class	kedro_dagster.datasets	A Kedro dataset used to represent placeholder outputs.
`DagsterPartitionedDataset`	Class	kedro_dagster.datasets	Kedro dataset that enables Dagster partitioning.
`DaskClusterConfig`	Class	kedro_dagster.config	Configuration for the Dask cluster.
`DaskExecutorOptions`	Class	kedro_dagster.config	Options for the Dask executor.
`DockerExecutorOptions`	Class	kedro_dagster.config	Options for the Docker-based executor.
`ExecutorCreator`	Class	kedro_dagster.dagster	Create Dagster executor definitions from Kedro-Dagster configuration.
`find_kedro_project`	Function	kedro_dagster.utils	Locate the Kedro project root starting from ``current_dir``.
`format_dataset_name`	Function	kedro_dagster.utils	Convert a dataset name so that it is valid under Dagster's naming convention.
`format_node_name`	Function	kedro_dagster.utils	Convert a node name so that it is valid under Dagster's naming convention.
`format_partition_key`	Function	kedro_dagster.utils	Format a partition key into a Dagster-safe suffix (``^[A-Za-z0-9_]+$``).
`get_asset_key_from_dataset_name`	Function	kedro_dagster.utils	Get a Dagster AssetKey from a Kedro dataset name and environment.
`get_dagster_config`	Function	kedro_dagster.config	Get the Dagster configuration from the ``dagster.yml`` file.
`get_dataset_from_catalog`	Function	kedro_dagster.utils	Retrieve a dataset instance from a Kedro catalog across versions.
`get_filter_params_dict`	Function	kedro_dagster.utils	Extract filter parameters from a pipeline config dict.
`get_match_pattern_from_catalog_resolver`	Function	kedro_dagster.utils	Return the matching dataset pattern from a CatalogConfigResolver.
`get_mlflow_resource_from_config`	Function	kedro_dagster.utils	Create a Dagster resource definition from MLflow config.
`get_mlflow_run_url`	Function	kedro_dagster.utils	Return a fully functional MLflow UI URL for the currently active run.
`get_partition_mapping`	Function	kedro_dagster.utils	Get the appropriate partition mapping for an asset based on its downstream datasets.
`getLogger`	Function	kedro_dagster.logging	Return a logger, preferring Dagster's logger when a run is active.
`init`	Function	kedro_dagster.cli	Scaffold or refresh Dagster integration files for the current Kedro project.
`InProcessExecutorOptions`	Class	kedro_dagster.config	Options for the in-process executor.
`is_mlflow_enabled`	Function	kedro_dagster.utils	Check if MLflow is enabled in the Kedro context.
`is_nothing_asset_name`	Function	kedro_dagster.utils	Return True if the catalog entry is a DagsterNothingDataset.
`JobOptions`	Class	kedro_dagster.config	Configuration options for a Dagster job.
`K8sJobConfig`	Class	kedro_dagster.config	Configuration for Kubernetes jobs.
`K8sJobExecutorOptions`	Class	kedro_dagster.config	Options for the Kubernetes-based executor.
`KedroDagsterConfig`	Class	kedro_dagster.config	Main configuration class representing the ``dagster.yml`` structure.
`KedroProjectTranslator`	Class	kedro_dagster.translator	Translate a Kedro project into a Dagster code location.
`KedroRunTranslator`	Class	kedro_dagster.kedro	Translator for Kedro run params.
`LoggerCreator`	Class	kedro_dagster.dagster	Create Dagster logger definitions from Kedro-Dagster configuration.
`LoggerOptions`	Class	kedro_dagster.config	Options for defining Dagster loggers.
`MultiprocessExecutorOptions`	Class	kedro_dagster.config	Options for the multiprocess executor.
`NodeTranslator`	Class	kedro_dagster.nodes	Translate Kedro nodes into Dagster ops and assets.
`parse_dagster_definition`	Function	kedro_dagster.datasets	Parse and instantiate a partition definition class using a config.
`PipelineOptions`	Class	kedro_dagster.config	Options for filtering and configuring Kedro pipelines within a Dagster job.
`PipelineTranslator`	Class	kedro_dagster.pipelines	Translator for Kedro pipelines to Dagster jobs.
`render_jinja_template`	Function	kedro_dagster.utils	Render a Jinja template from a file or string.
`scaffold_dagster_files`	Function	kedro_dagster.cli	Scaffold or refresh Dagster integration files for the current Kedro project.
`ScheduleCreator`	Class	kedro_dagster.dagster	Create Dagster schedule definitions from Kedro configuration.
`ScheduleOptions`	Class	kedro_dagster.config	Options for defining Dagster schedules.
`unformat_asset_name`	Function	kedro_dagster.utils	Convert a Dagster-formatted asset name back to Kedro's naming convention.
`write_jinja_template`	Function	kedro_dagster.utils	Render and write a Jinja template to a destination file.