academic_observatory_workflows.scopus_telescope.telescope
=========================================================

.. py:module:: academic_observatory_workflows.scopus_telescope.telescope


Classes
-------

.. autoapisummary::

   academic_observatory_workflows.scopus_telescope.telescope.DagParams


Functions
---------

.. autoapisummary::

   academic_observatory_workflows.scopus_telescope.telescope.create_dag


Module Contents
---------------

.. py:class:: DagParams(*, dag_id: str, cloud_workspace: observatory_platform.airflow.workflow.CloudWorkspace, institution_ids: List[str], scopus_conn_ids: List[str], view: str = 'STANDARD', earliest_date: pendulum.DateTime = pendulum.datetime(1800, 1, 1), bq_dataset_id: str = 'scopus', bq_table_name: str = 'scopus', api_bq_dataset_id: str = 'dataset_api', schema_folder: str = project_path('scopus_telescope', 'schema'), dataset_description: str = 'The Scopus citation database: https://www.scopus.com', table_description: str = 'The Scopus citation database: https://www.scopus.com', start_date: pendulum.DateTime = pendulum.datetime(2018, 5, 14), schedule: str = '@monthly', max_active_runs: int = 1, retries: int = 3)

   :param dag_id: the id of the DAG.
   :param cloud_workspace: the cloud workspace settings.
   :param institution_ids: list of institution IDs to use for the Scopus search query.
   :param scopus_conn_ids: list of Scopus Airflow Connection IDs.
   :param view: The view type. Standard or complete. See https://dev.elsevier.com/sc_search_views.html
   :param earliest_date: earliest date to query for results.
   :param bq_dataset_id: the BigQuery dataset id.
   :param bq_table_name: the BigQuery table name.
   :param api_bq_dataset_id: the Dataset ID to use when storing releases.
   :param schema_folder: the SQL schema path.
   :param dataset_description: description for the BigQuery dataset.
   :param table_description: description for the BigQuery table.
   :param observatory_api_conn_id: the Observatory API connection key.
   :param start_date: the start date of the DAG.
   :param schedule: the schedule interval of the DAG.
   :param max_active_runs: the maximum number of DAG runs that can be run at once.
   :param retries: the number of times to retry a task.


   .. py:attribute:: dag_id


   .. py:attribute:: cloud_workspace


   .. py:attribute:: institution_ids


   .. py:attribute:: scopus_conn_ids


   .. py:attribute:: view
      :value: 'STANDARD'



   .. py:attribute:: earliest_date


   .. py:attribute:: bq_dataset_id
      :value: 'scopus'



   .. py:attribute:: bq_table_name
      :value: 'scopus'



   .. py:attribute:: api_bq_dataset_id
      :value: 'dataset_api'



   .. py:attribute:: schema_folder


   .. py:attribute:: dataset_description
      :value: 'The Scopus citation database: https://www.scopus.com'



   .. py:attribute:: table_description
      :value: 'The Scopus citation database: https://www.scopus.com'



   .. py:attribute:: start_date


   .. py:attribute:: schedule
      :value: '@monthly'



   .. py:attribute:: max_active_runs
      :value: 1



   .. py:attribute:: retries
      :value: 3



.. py:function:: create_dag(dag_params: DagParams)

   Scopus telescope.