provider

Provider

Full-scope provider — assembles schema, database, and account resources.

Entry point for CLI and CI/CD pipelines. Never use inside a stored procedure (imports the full resource graph including account-level objects).

The manifest's scope selects which sub-provider runs. Only account scope is wired in this first slice; schema and database follow.

Example

.. code-block:: python

from pinky_provider import Provider

provider = Provider(session)
provider.plan(source="manifest.yml", env="SANDBOX")
provider.apply(source="manifest.yml", env="SANDBOX")

Parameters:

Name	Type	Description	Default
session	Any	Active Snowpark Session.	required

Source code in src/pinky_provider/provider.py

class Provider:
    """Full-scope provider — assembles schema, database, and account resources.

    Entry point for CLI and CI/CD pipelines. Never use inside a stored procedure
    (imports the full resource graph including account-level objects).

    The manifest's ``scope`` selects which sub-provider runs. Only ``account`` scope is wired in
    this first slice; ``schema`` and ``database`` follow.

    Example:
        .. code-block:: python

            from pinky_provider import Provider

            provider = Provider(session)
            provider.plan(source="manifest.yml", env="SANDBOX")
            provider.apply(source="manifest.yml", env="SANDBOX")

    Args:
        session: Active Snowpark ``Session``.
    """

    def __init__(self, session: Any) -> None:
        self._session = session
        self.schema = SchemaProvider(session)
        self.database = DatabaseProvider(session)
        self.account = AccountProvider(session)

    def _route(self, manifest: Manifest) -> AccountProvider:
        if manifest.scope == "account":
            return self.account
        raise NotImplementedError(
            f"scope {manifest.scope!r} not implemented yet — only 'account' is wired"
        )

    def plan(
        self,
        source: str,
        target: str | None = None,
        env: str = "SANDBOX",
        vars: dict[str, str] | None = None,
    ) -> list[ResourceDiff]:
        """Compute the full change plan without applying anything.

        Args:
            source: Path to ``manifest.yml``.
            target: Target schema as ``DATABASE.SCHEMA`` (schema scope) — unused at account scope.
            env: Environment selecting ``vars/<env>.yml`` (e.g. ``SANDBOX``).
            vars: Variable overrides injected into the manifest.

        Returns:
            Ordered list of :class:`~pinky_provider.core.diff.ResourceDiff`.
        """
        manifest = Manifest(source, env=env, vars=vars)
        return self._route(manifest).plan(manifest)

    def apply(
        self,
        source: str,
        target: str | None = None,
        env: str = "SANDBOX",
        vars: dict[str, str] | None = None,
    ) -> list[ResourceDiff]:
        """Apply the manifest — deploys or alters all declared objects.

        Args:
            source: Path to ``manifest.yml``.
            target: Target schema as ``DATABASE.SCHEMA`` (schema scope) — unused at account scope.
            env: Environment selecting ``vars/<env>.yml``.
            vars: Variable overrides injected into the manifest.

        Returns:
            The diffs actually executed.
        """
        manifest = Manifest(source, env=env, vars=vars)
        return self._route(manifest).apply(manifest)

apply(source, target=None, env='SANDBOX', vars=None)

Apply the manifest — deploys or alters all declared objects.

Parameters:

Name	Type	Description	Default
source	str	Path to manifest.yml.	required
target	str | None	Target schema as DATABASE.SCHEMA (schema scope) — unused at account scope.	None
env	str	Environment selecting vars/<env>.yml.	'SANDBOX'
vars	dict[str, str] | None	Variable overrides injected into the manifest.	None

Returns:

Type	Description
list[ResourceDiff]	The diffs actually executed.

Source code in src/pinky_provider/provider.py

def apply(
    self,
    source: str,
    target: str | None = None,
    env: str = "SANDBOX",
    vars: dict[str, str] | None = None,
) -> list[ResourceDiff]:
    """Apply the manifest — deploys or alters all declared objects.

    Args:
        source: Path to ``manifest.yml``.
        target: Target schema as ``DATABASE.SCHEMA`` (schema scope) — unused at account scope.
        env: Environment selecting ``vars/<env>.yml``.
        vars: Variable overrides injected into the manifest.

    Returns:
        The diffs actually executed.
    """
    manifest = Manifest(source, env=env, vars=vars)
    return self._route(manifest).apply(manifest)

plan(source, target=None, env='SANDBOX', vars=None)

Compute the full change plan without applying anything.

Parameters:

Name	Type	Description	Default
source	str	Path to manifest.yml.	required
target	str | None	Target schema as DATABASE.SCHEMA (schema scope) — unused at account scope.	None
env	str	Environment selecting vars/<env>.yml (e.g. SANDBOX).	'SANDBOX'
vars	dict[str, str] | None	Variable overrides injected into the manifest.	None

Returns:

Type	Description
list[ResourceDiff]	Ordered list of :class:~pinky_provider.core.diff.ResourceDiff.

Source code in src/pinky_provider/provider.py

def plan(
    self,
    source: str,
    target: str | None = None,
    env: str = "SANDBOX",
    vars: dict[str, str] | None = None,
) -> list[ResourceDiff]:
    """Compute the full change plan without applying anything.

    Args:
        source: Path to ``manifest.yml``.
        target: Target schema as ``DATABASE.SCHEMA`` (schema scope) — unused at account scope.
        env: Environment selecting ``vars/<env>.yml`` (e.g. ``SANDBOX``).
        vars: Variable overrides injected into the manifest.

    Returns:
        Ordered list of :class:`~pinky_provider.core.diff.ResourceDiff`.
    """
    manifest = Manifest(source, env=env, vars=vars)
    return self._route(manifest).plan(manifest)