cwolff commited on
Commit
d5e07bf
·
verified ·
1 Parent(s): c9315b6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +62 -62
README.md CHANGED
@@ -1,62 +1,62 @@
1
- ---
2
- pretty_name: SchemaPile
3
- tags:
4
- - SQL
5
- - Schemas
6
- ---
7
-
8
- # SchemaPile
9
-
10
- ### Usage
11
-
12
- ```python
13
- from datasets import load_dataset
14
- ds = load_dataset("cwolff/schemapile", split="full")
15
- print(f"Loaded dataset with {len(ds)} records.")
16
- print(ds[0])
17
- ```
18
-
19
- ### Description
20
-
21
- SchemaPile is a collection of database schemas extracted from various sources, normalized for consistency and ease of use in machine learning workflows. Each record contains metadata (`INFO`), licensing information, permissiveness, and a list of tables with detailed column specifications.
22
-
23
- ### Schema
24
-
25
- - **INFO:**
26
- - `ID`: Unique identifier (from filename prefix)
27
- - `FILENAME`: Original filename
28
- - Additional metadata fields
29
-
30
- - **LICENSE:** License string (if available)
31
- - **PERMISSIVE:** Boolean indicating permissive license
32
- - **TABLES:** List of tables, each with:
33
- - `TABLE_NAME`: Name of the table
34
- - `COLUMNS`: List of columns, each with:
35
- - `NAME`, `TYPE`, `NULLABLE`, `UNIQUE`, `DEFAULT`, `CHECKS`, `IS_PRIMARY`, `IS_INDEX`, `VALUES`
36
- - `PRIMARY_KEYS`, `FOREIGN_KEYS`, `CHECKS`, `INDEXES`
37
-
38
- ### Citation
39
-
40
- If you use SchemaPile in your research, please cite:
41
-
42
- > ```bibtex
43
- > @article{dohmen2024schemapile,
44
- > title={Schemapile: A large collection of relational database schemas},
45
- > author={D{"o}hmen, Till and Geacu, Radu and Hulsebos, Madelon and Schelter, Sebastian},
46
- > journal={Proceedings of the ACM on Management of Data},
47
- > volume={2},
48
- > number={3},
49
- > pages={1--25},
50
- > year={2024},
51
- > publisher={ACM New York, NY, USA}
52
- > ```
53
-
54
- **[Read the paper](https://schemapile.github.io/assets/SchemaPile.pdf)**
55
-
56
- ### Website
57
-
58
- For more information, visit the [SchemaPile website](https://schemapile.github.io/).
59
-
60
- ### License
61
-
62
- See individual record `LICENSE` fields for details. The `PERMISSIVE` flag indicates whether the schema is under a permissive license.
 
1
+ ---
2
+ pretty_name: SchemaPile
3
+ tags:
4
+ - SQL
5
+ - Schemas
6
+ ---
7
+
8
+ # SchemaPile
9
+
10
+ ### Usage
11
+
12
+ ```python
13
+ from datasets import load_dataset
14
+ ds = load_dataset("trl-lab/schemapile", split="full")
15
+ print(f"Loaded dataset with {len(ds)} records.")
16
+ print(ds[0])
17
+ ```
18
+
19
+ ### Description
20
+
21
+ SchemaPile is a collection of database schemas extracted from various sources, normalized for consistency and ease of use in machine learning workflows. Each record contains metadata (`INFO`), licensing information, permissiveness, and a list of tables with detailed column specifications.
22
+
23
+ ### Schema
24
+
25
+ - **INFO:**
26
+ - `ID`: Unique identifier (from filename prefix)
27
+ - `FILENAME`: Original filename
28
+ - Additional metadata fields
29
+
30
+ - **LICENSE:** License string (if available)
31
+ - **PERMISSIVE:** Boolean indicating permissive license
32
+ - **TABLES:** List of tables, each with:
33
+ - `TABLE_NAME`: Name of the table
34
+ - `COLUMNS`: List of columns, each with:
35
+ - `NAME`, `TYPE`, `NULLABLE`, `UNIQUE`, `DEFAULT`, `CHECKS`, `IS_PRIMARY`, `IS_INDEX`, `VALUES`
36
+ - `PRIMARY_KEYS`, `FOREIGN_KEYS`, `CHECKS`, `INDEXES`
37
+
38
+ ### Citation
39
+
40
+ If you use SchemaPile in your research, please cite:
41
+
42
+ > ```bibtex
43
+ > @article{dohmen2024schemapile,
44
+ > title={Schemapile: A large collection of relational database schemas},
45
+ > author={D{"o}hmen, Till and Geacu, Radu and Hulsebos, Madelon and Schelter, Sebastian},
46
+ > journal={Proceedings of the ACM on Management of Data},
47
+ > volume={2},
48
+ > number={3},
49
+ > pages={1--25},
50
+ > year={2024},
51
+ > publisher={ACM New York, NY, USA}
52
+ > ```
53
+
54
+ **[Read the paper](https://schemapile.github.io/assets/SchemaPile.pdf)**
55
+
56
+ ### Website
57
+
58
+ For more information, visit the [SchemaPile website](https://schemapile.github.io/).
59
+
60
+ ### License
61
+
62
+ See individual record `LICENSE` fields for details. The `PERMISSIVE` flag indicates whether the schema is under a permissive license.