f660b0a946
Template generation for new Source using the Santa CDK - provide basic scaffolding for someone implementing a new source. General approach is to buff up comments in the original SDK, and add TODOs with secondary comments in the generated stub methods, as well as links to existing examples (e.g. Stripe or ExchangeRate api) users can look at. Checked in and added tests for the generated modules.
115 lines
4.5 KiB
Python
115 lines
4.5 KiB
Python
# MIT License
|
|
#
|
|
# Copyright (c) 2020 Airbyte
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in all
|
|
# copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
# SOFTWARE.
|
|
|
|
|
|
import copy
|
|
from datetime import datetime
|
|
from typing import Any, Iterator, Mapping, MutableMapping, Type
|
|
|
|
from airbyte_protocol import (
|
|
AirbyteCatalog,
|
|
AirbyteConnectionStatus,
|
|
AirbyteMessage,
|
|
AirbyteRecordMessage,
|
|
AirbyteStateMessage,
|
|
ConfiguredAirbyteCatalog,
|
|
ConfiguredAirbyteStream,
|
|
Status,
|
|
SyncMode,
|
|
)
|
|
from airbyte_protocol import Type as MessageType
|
|
|
|
from .client import BaseClient
|
|
from .integration import Source
|
|
from .logger import AirbyteLogger
|
|
|
|
|
|
class BaseSource(Source):
|
|
"""Base source that designed to work with clients derived from BaseClient"""
|
|
|
|
client_class: Type[BaseClient] = None
|
|
|
|
@property
|
|
def name(self) -> str:
|
|
"""Source name"""
|
|
return self.__class__.__name__
|
|
|
|
def _get_client(self, config: Mapping):
|
|
"""Construct client"""
|
|
client = self.client_class(**config)
|
|
|
|
return client
|
|
|
|
def discover(self, logger: AirbyteLogger, config: Mapping[str, Any]) -> AirbyteCatalog:
|
|
"""Discover streams"""
|
|
client = self._get_client(config)
|
|
|
|
return AirbyteCatalog(streams=[stream for stream in client.streams])
|
|
|
|
def check(self, logger: AirbyteLogger, config: Mapping[str, Any]) -> AirbyteConnectionStatus:
|
|
"""Check connection"""
|
|
client = self._get_client(config)
|
|
alive, error = client.health_check()
|
|
if not alive:
|
|
return AirbyteConnectionStatus(status=Status.FAILED, message=str(error))
|
|
|
|
return AirbyteConnectionStatus(status=Status.SUCCEEDED)
|
|
|
|
def read(
|
|
self, logger: AirbyteLogger, config: Mapping[str, Any], catalog: ConfiguredAirbyteCatalog, state: MutableMapping[str, Any] = None
|
|
) -> Iterator[AirbyteMessage]:
|
|
state = state or {}
|
|
client = self._get_client(config)
|
|
|
|
logger.info(f"Starting syncing {self.name}")
|
|
total_state = copy.deepcopy(state)
|
|
for configured_stream in catalog.streams:
|
|
try:
|
|
yield from self._read_stream(logger=logger, client=client, configured_stream=configured_stream, state=total_state)
|
|
|
|
except Exception:
|
|
logger.exception(f"Encountered an exception while reading stream {self.name}")
|
|
raise
|
|
|
|
logger.info(f"Finished syncing {self.name}")
|
|
|
|
def _read_stream(
|
|
self, logger: AirbyteLogger, client: BaseClient, configured_stream: ConfiguredAirbyteStream, state: MutableMapping[str, Any]
|
|
):
|
|
stream_name = configured_stream.stream.name
|
|
use_incremental = configured_stream.sync_mode == SyncMode.incremental and client.stream_has_state(stream_name)
|
|
|
|
if use_incremental and state.get(stream_name):
|
|
logger.info(f"Set state of {stream_name} stream to {state.get(stream_name)}")
|
|
client.set_stream_state(stream_name, state.get(stream_name))
|
|
|
|
logger.info(f"Syncing {stream_name} stream")
|
|
for record in client.read_stream(configured_stream.stream):
|
|
now = int(datetime.now().timestamp()) * 1000
|
|
message = AirbyteRecordMessage(stream=stream_name, data=record, emitted_at=now)
|
|
yield AirbyteMessage(type=MessageType.RECORD, record=message)
|
|
|
|
if use_incremental and client.get_stream_state(stream_name):
|
|
state[stream_name] = client.get_stream_state(stream_name)
|
|
# output state object only together with other stream states
|
|
yield AirbyteMessage(type=MessageType.STATE, state=AirbyteStateMessage(data=state))
|