Source code for terracotta.drivers.sqlite_remote

"""drivers/sqlite.py

SQLite-backed raster driver. Metadata is stored in an SQLite database, raster data is assumed
to be present on disk.
"""

from typing import Any, Iterator
import os
import tempfile
import shutil
import operator
import logging
import contextlib
import urllib.parse as urlparse

from cachetools import cachedmethod, TTLCache

from terracotta import get_settings, exceptions
from terracotta.drivers.sqlite import SQLiteDriver
from terracotta.profile import trace

logger = logging.getLogger(__name__)


@contextlib.contextmanager
def convert_exceptions(msg: str) -> Iterator:
    """Convert internal sqlite and boto exceptions to our InvalidDatabaseError"""
    import sqlite3
    import botocore.exceptions
    try:
        yield
    except (sqlite3.OperationalError, botocore.exceptions.ClientError) as exc:
        raise exceptions.InvalidDatabaseError(msg) from exc


def _update_from_s3(remote_path: str, local_path: str) -> None:
    import boto3

    parsed_remote_path = urlparse.urlparse(remote_path)
    bucket_name, key = parsed_remote_path.netloc, parsed_remote_path.path.strip('/')

    if parsed_remote_path.scheme != 's3':
        raise ValueError('Expected s3:// URL')

    s3 = boto3.resource('s3')
    obj = s3.Object(bucket_name, key)
    obj_bytes = obj.get()['Body']

    # copy over existing database; this is somewhat safe since it is read-only
    # NOTE: replace with Connection.backup after switching to Python 3.7
    with open(local_path, 'wb') as f:
        shutil.copyfileobj(obj_bytes, f)


[docs]class RemoteSQLiteDriver(SQLiteDriver): """An SQLite-backed raster driver, where the database file is stored remotely on S3. Assumes raster data to be present in separate GDAL-readable files on disk or remotely. Stores metadata and paths to raster files in SQLite. See also: :class:`~terracotta.drivers.sqlite.SQLiteDriver` for the local version of this driver. The SQLite database is simply a file that can be stored together with the actual raster files on S3. Before handling the first request, this driver will download a temporary copy of the remote database file. It is thus not feasible for large databases. The local database copy will be updated in regular intervals defined by :attr:`~terracotta.config.TerracottaSettings.REMOTE_DB_CACHE_TTL`. Warning: This driver is read-only. Any attempts to use the create, insert, or delete methods will throw a NotImplementedError. """ path: str
[docs] def __init__(self, remote_path: str) -> None: """Initialize the RemoteSQLiteDriver. This should not be called directly, use :func:`~terracotta.get_driver` instead. Arguments: remote_path: S3 URL in the form ``s3://bucket/key`` to remote SQLite database (has to exist). """ settings = get_settings() self.__rm = os.remove # keep reference to use in __del__ os.makedirs(settings.REMOTE_DB_CACHE_DIR, exist_ok=True) local_db_file = tempfile.NamedTemporaryFile( dir=settings.REMOTE_DB_CACHE_DIR, prefix='tc_s3_db_', suffix='.sqlite', delete=False ) local_db_file.close() self._remote_path: str = str(remote_path) self._checkdb_cache = TTLCache(maxsize=1, ttl=settings.REMOTE_DB_CACHE_TTL) super().__init__(local_db_file.name)
@cachedmethod(operator.attrgetter('_checkdb_cache')) @convert_exceptions('Could not retrieve database from S3') @trace('download_db_from_s3') def _update_db(self, remote_path: str, local_path: str) -> None: logger.debug('Remote database cache expired, re-downloading') _update_from_s3(remote_path, local_path) def _connection_callback(self) -> None: self._update_db(self._remote_path, self.path) super()._connection_callback() def create(self, *args: Any, **kwargs: Any) -> None: raise NotImplementedError('Remote SQLite databases are read-only') def insert(self, *args: Any, **kwargs: Any) -> None: raise NotImplementedError('Remote SQLite databases are read-only') def delete(self, *args: Any, **kwargs: Any) -> None: raise NotImplementedError('Remote SQLite databases are read-only') def __del__(self) -> None: """Clean up temporary database upon exit""" self.__rm(self.path)