ploomber.products.SQLRelation

class ploomber.products.SQLRelation(identifier)

A product that represents a SQL relation (table or view) with no metadata (incremental builds won’t work). See ploomber.products.GenericSQLRelation if you want to enable incremental builds.

Parameters:

identifier (tuple of length 3) – A tuple with (schema, name, kind) where kind must be either ‘table’ or ‘view’

See also

ploomber.products.GenericSQLRelation

SQL relation (table or view) that stores metadata (to enable incremental builds) in a SQLite database.

Methods

delete([force])

Deletes the product

download()

exists()

This method returns True if the product exists, it is not part of the metadata, so there is no cached status

fetch_metadata()

render(params, **kwargs)

Render Product - this will render contents of Templates used as identifier for this Product, if a regular string was passed, this method has no effect

save_metadata(metadata)

to_json_serializable()

Returns a JSON serializable version of this product

upload()

delete(force=False)

Deletes the product

download()
exists()

This method returns True if the product exists, it is not part of the metadata, so there is no cached status

fetch_metadata()
render(params, **kwargs)

Render Product - this will render contents of Templates used as identifier for this Product, if a regular string was passed, this method has no effect

save_metadata(metadata)
to_json_serializable()

Returns a JSON serializable version of this product

upload()

Attributes

client

kind

name

schema

task