https://github.com/folio-org/folio-analytics
Community query repository for FOLIO analytics based on Metadb/LDP
https://github.com/folio-org/folio-analytics
Last synced: 5 months ago
JSON representation
Community query repository for FOLIO analytics based on Metadb/LDP
- Host: GitHub
- URL: https://github.com/folio-org/folio-analytics
- Owner: folio-org
- License: apache-2.0
- Created: 2018-11-19T21:17:29.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-06-11T23:57:04.000Z (about 1 year ago)
- Last Synced: 2025-10-25T08:21:57.138Z (8 months ago)
- Language: SQL
- Homepage:
- Size: 3.43 MB
- Stars: 16
- Watchers: 16
- Forks: 32
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# folio-analytics
Copyright (C) 2018-2025 The Open Library Foundation
This software is distributed under the terms of the Apache License,
Version 2.0. See the file "[LICENSE](LICENSE)" for more information.
## Releases
Each release of folio-analytics is tested with a specific FOLIO
release, but it may also work with other FOLIO releases.
| FOLIO | LDP | Metadb |
| ------------- | :----------------------: | :----------------------------------: |
| Kiwi | folio-analytics 1.2 | |
| Lotus | folio-analytics 1.3 | |
| Morning Glory | folio-analytics 1.4 | |
| Nolana | folio-analytics 1.5 | folio-analytics 1.7 (Metadb 1.2) |
| Orchid | folio-analytics 1.6 | |
| Poppy | folio-analytics 1.7 | |
| Quesnelia | | |
| Ramsons | | |
| Sunflower | | |
## Overview
This repository contains reports and other analytics developed for
FOLIO and designed to run on the [Library Data
Platform](https://github.com/library-data-platform/ldp). 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](https://www.folio.org/community/support/). In
addition to report development, FOLIO has a [Reporting Special
Interest Group](https://wiki.folio.org/display/RPT/) that discusses
reporting requirements and other related topics.
## How to use this repository
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](https://metadb.dev/doc/) and [LDP User
Guide](https://github.com/library-data-platform/ldp/blob/main/doc/User_Guide.md)
include guidelines for writing queries.
## Queries
Metadb SQL queries are stored in the [sql_metadb
directory](sql_metadb) of this repository. Queries are separated into
two categories: [derived table queries](sql_metadb/derived_tables) and
[report queries](sql_metadb/report_queries). LDP SQL queries are
stored in the [sql directory](sql).
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](sql_metadb/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.
## Branches
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.