Copyright (C) 2018-2023 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Each release of folio-analytics is tested with a specific FOLIO release, but it may also work with other FOLIO releases.

This repository contains reports and other analytics developed for FOLIO and designed to run on the Library Data Platform. At present most of the content here consists of SQL reports developed by the FOLIO reporting community and based on the requirements of FOLIO partner libraries. In addition to report development, FOLIO has a Reporting Special Interest Group that discusses reporting requirements and other related topics.

Metadb/LDP-based queries are written in SQL. To use these queries, you will need to connect to a Metadb or LDP database instance using a reporting tool that supports SQL. Examples of reporting tools that will execute SQL include DBeaver, Aqua Data Studio, and Tableau.

If none of the queries provided match your needs, you can look for an existing query to use as a starting point and edit the query to create the desired output. The Metadb Documentation and LDP User Guide include guidelines for writing queries.

Metadb SQL queries are stored in the sql_metadb directory of this repository. Queries are separated into two categories: derived table queries and report queries. LDP SQL queries are stored in the sql directory.

Derived table queries are designed to combine tables that are commonly used together or to otherwise simply querying.

Report queries are created in response to specific report requests from FOLIO member institutions. Each query is located in a separate directory. A full report may contain several individual queries. Consult the README.md file in the report queries folder for a query table of contents, and look for additional README.md files in the query folders to explain how to run the reports.

There are two primary types of branches:

• The main branch (main). This is a development branch where new features are first merged. This branch is relatively unstable. It is also the default view when browsing the repository on GitHub.

• Release branches (release-*). These are releases made from main. They are managed as stable branches; i.e. they may receive bug fixes but generally no new features. Production deployments should install release tags.