tilezilla.db package

Module contents

Database for tilezilla

This submodule assists with access to the database that indexes products ingested by tilezilla. The chief way of accessing the database is via the Database, DatacubeResource, and DatasetResource.

The “resources” are designed to be a higher level access to the database. As such, DatacubeResource and DatasetResource both return instances of the object type (a tile specification, a tile, a product, a band) requested while Database will return a SqlAlchemy ORM object instance retrieved from the database.

The DatacubeResource handles tile specifications and tiles while the DatasetResource deals with products and bands.

TODO: * Searches

• Search using filter_by by combining keyword arguments for each database level (Tile, Product, Band) and dictionaries passed to these keyword arguments
• Tie this search into click CLI (multiple key=value flags)

• Database info request

  • Get fields
  • Tie field enumeration to click CLI
  • Some kind of field -> click option generator?
  • E.g., tilez db info tile --horizontal=<int>

• Summary statistics about a database tile, collection, etc.

  • http://sqlalchemy-utils.readthedocs.org/en/latest/aggregates.html

class tilezilla.db.Database(engine, session)

Bases: object

The database connection

classmethod connect(uri, connect_args=None, debug=False)

Return a Database for a given URI

Parameters:

• URI (str) – Resource location
• connect_args (dict) – Optional connection arguments
• debug (bool) – Turn on sqlalchemy debug echo

Returns:

Database

create_band(band)

Band to TableBand without a product_id

create_product(product)

create_tile(tilespec_id, storage, collection, horizontal, vertical, bounds)

ensure_band(product_id, band)

ensure_product(tile_id, product)

ensure_tile(tilespec_id, storage, collection, horizontal, vertical, bounds)

ensure_tilespec(desc, ul, crs, res, size)

Get or add a TileSpec to the database

classmethod from_config(config=None)

get_band(id_)

get_band_by_name(product_id, name)

get_product(id_)

get_product_by_name(tile_id, name)

get_products_by_name(name)

get_tile(id_)

get_tile_by_tile_index(tilespec_id, storage, collection, horizontal, vertical)

get_tilespec(id_)

get_tilespec_by_name(name)

scope()

Session as a context manager

Intended to be used as follows:

..code-block:: python

with db.scope() as scope:

# do stuff

update_band(product_id, band)

update_product(tile_id, product)

class tilezilla.db.DatacubeResource(db, tilespec, storage)

Bases: object

Tiles of products for a given tile specification

Parameters:

• db (Database) – Database connection
• tilespec (TileSpec) – Tile specification for datacube
• storage (str) – Storage type from tilezilla.stores.STORAGE_TYPES

ensure_tile(collection, horizontal, vertical)

get_tile(id_)

get_tile_by_tile_index(collection, horizontal, vertical)

init_tilespec(tilespec)

class tilezilla.db.DatasetResource(db, datacube)

Bases: object

Individual dataset product observations

ensure_band(product_id, band)

Add a band to index, creating if necessary

Parameters:

• product_id (int) – ID of product that band belongs to
• band (Band) – An observation in some band belonging to a product

Returns:

Database ID for the band added or retrieved

Return type:

int

ensure_product(tile_id, product)

Add a product to index, creating if needed

Returns:Database ID of the product added or retrieved Return type:int

get_band(_id)

Return Band by ID

get_product(id_)

Get product by id

get_product_bands(tile_id, product)

Return list of Bands indexed from a product for a given tile

Parameters:

• tile_id (int) – Check for products in this tile
• product (BaseProduct) – The product to check for

Returns:

A list of :class:`Band`s indexed for this product and tile

Return type:

list[Band]

get_product_by_name(tile_id, name)

Get product by name within a tile

get_products_by_name(name)

Get all products matching timeseries_id, regardless of tile

get_products_by_tile(tile_id)

Get all products within a tile

update_band(product_id, band)

Add a new band, updating existing band if necessary

Parameters:

• product_id (int) – ID of product that band belongs to
• band (Band) – An observation in some band belonging to a product

Returns:

Database ID for band added or updated

Return type:

int