orcid

Populate ORCID data tables

orcid.populate(database_path, data_path, columns=None, authors_only=False, works_only=False)

Populate the specified SQLite database. The database is created if it does not exist. If it exists, the tables to be populated are dropped (if they exist) and recreated anew as specified.

Parameters:
  • database_path (str) – Path specifying the SQLite database to populate.

  • data_path (str) – Path to the ORCID summaries data file, e.g. “ORCID_2022_10_summaries.tar.gz”

  • columns (list, optional) – A list of strings specifying the columns to populate, defaults to None. The strings are of the form table_name.column_name or table_name.*.

  • authors_only (bool, optional) – Specify whether only ORCID records of persons that exist in the Crossref work_authors table shall be added, defaults to False.

  • works_only (bool, optional) – Specify whether only ORCID records of persons whose works exist in the Crossref works table shall be added, defaults to False.