folios / README.md
tacman1123's picture
Upload README.md with huggingface_hub
9e98282 verified
|
Raw
History Blame Contribute Delete
2.77 kB
---
license: other
license_name: per-dataset
license_link: LICENSE
task_categories:
- image-classification
- text-retrieval
language:
- en
- mul
tags:
- museum
- cultural-heritage
- sqlite
- iiif
- folio
pretty_name: Museado Folios
size_categories:
- 1K<n<10K
---
# Museado Folios
Portable SQLite archives of normalized museum collection data. Each `.folio.sqlite.gz` file is a self-describing, standalone database containing items, metadata, and schema documentation.
## What is a Folio?
A folio is a SQLite file with a defined set of tables storing normalized cultural heritage records. Each folio contains:
- **item** — normalized rows with structured DTO data and display labels
- **schema_table / schema_property** — observed field metadata with types, stats, and display hints
- **docs** — generated human/machine-readable documentation
- **term_set / term** — controlled vocabularies
- **core** — named collections within the folio
- **relation_type / relation** — typed links between items
## Usage
Download and query directly with `sqlite3`:
```bash
gunzip mus/cleveland.folio.sqlite.gz
sqlite3 mus/cleveland.folio.sqlite
```
```sql
-- Browse items
SELECT local_id, label, dto_type FROM item LIMIT 20;
-- Explore the schema
SELECT name, sql FROM sqlite_master WHERE type = 'table';
-- Read documentation
SELECT id, title, type FROM docs ORDER BY position;
-- Query DTO fields via JSON
SELECT local_id, json_extract(dto_data, '$.title'), json_extract(dto_data, '$.date')
FROM item WHERE dto_type = 'painting' LIMIT 10;
```
## Archive Format
These are **deflated** folios — no secondary indexes, no FTS5 search tables, no generated views. This keeps them small for distribution. To inflate for browsing/searching, use `folio-bundle`:
```bash
php bin/console folio:restore path/to/archive.folio.sqlite.gz provider/dataset
```
## Schema
Every table's DDL includes inline SQL comments describing each column. Query `sqlite_master` for self-documentation:
```sql
SELECT sql FROM sqlite_master WHERE type = 'table' AND name = 'item';
```
## Source
Data is normalized from open-access museum APIs by [Museado](https://github.com/museado). All records in this repository are CC0 or equivalent open-access licensed by their source institutions.
## Collections
| Folio | Source | License |
|-------|--------|---------|
| mus/cleveland | Cleveland Museum of Art | CC0 |
| mus/walters | The Walters Art Museum | CC0 |
| mus/victoria | Museums Victoria | CC-BY |
| mus/auur | Autores Uruguay | Open |
| mus/aust | National Museum of Australia | Open |
| mus/belvedere | Belvedere Museum | CC0 |
| mus/munch | Munch Museum | Open |
| mus/larco | Museo Larco | Open |
| mus/awmm | Auckland War Memorial Museum | Open |