db_dump/
lib.rs

1//! [![github]](https://github.com/dtolnay/db-dump) [![crates-io]](https://crates.io/crates/db-dump) [![docs-rs]](https://docs.rs/db-dump)
2//!
3//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
4//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
5//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
6
7#![doc(html_root_url = "https://docs.rs/db-dump/0.7.13")]
8#![cfg_attr(not(check_cfg), allow(unexpected_cfgs))]
9#![allow(
10    clippy::cast_lossless,
11    clippy::cast_possible_truncation,
12    clippy::doc_markdown,
13    clippy::elidable_lifetime_names,
14    clippy::missing_errors_doc,
15    clippy::missing_panics_doc,
16    clippy::module_name_repetitions,
17    clippy::must_use_candidate,
18    clippy::needless_lifetimes,
19    clippy::too_many_lines,
20    clippy::uninlined_format_args,
21    clippy::unnecessary_map_or,
22    clippy::unreadable_literal,
23    clippy::unseparated_literal_suffix
24)]
25
26extern crate self as db_dump;
27
28mod bool;
29mod date;
30mod datetime;
31mod error;
32mod ignore;
33mod load;
34mod set;
35
36pub mod categories;
37pub mod crate_downloads;
38pub mod crate_owners;
39pub mod crates;
40pub mod crates_categories;
41pub mod crates_keywords;
42pub mod default_versions;
43pub mod dependencies;
44pub mod keywords;
45pub mod metadata;
46pub mod reserved_crate_names;
47pub mod teams;
48pub mod users;
49pub mod version_downloads;
50pub mod versions;
51
52pub use crate::date::Date;
53pub use crate::error::{Error, Result};
54pub use crate::load::{load_all, Loader};
55
56/// A crates.io DB dump with *everything* deserialized into memory. Use
57/// [`Loader`] to load only parts of a dump, which is more efficient.
58///
59/// One of these full dumps can be loaded via [`db_dump::load_all`].
60#[derive(Default)]
61#[non_exhaustive]
62pub struct DbDump {
63    /// <table style="width:initial"><tr>
64    /// <th>categories.csv</th>
65    /// <td>id</td>
66    /// <td>category</td>
67    /// <td>slug</td>
68    /// <td>description</td>
69    /// <td>crates_cnt</td>
70    /// <td>created_at</td>
71    /// <td>path</td>
72    /// </tr></table>
73    pub categories: Vec<categories::Row>,
74
75    /// <table style="width:initial"><tr>
76    /// <th>crate_downloads.csv</th>
77    /// <td>crate_id</td>
78    /// <td>downloads</td>
79    /// </tr></table>
80    pub crate_downloads: Vec<crate_downloads::Row>,
81
82    /// <table style="width:initial"><tr>
83    /// <th>crate_owners.csv</th>
84    /// <td>crate_id</td>
85    /// <td>owner_id</td>
86    /// <td>created_at</td>
87    /// <td>created_by</td>
88    /// <td>owner_kind</td>
89    /// </tr></table>
90    pub crate_owners: Vec<crate_owners::Row>,
91
92    /// <table style="width:initial"><tr>
93    /// <th>crates.csv</th>
94    /// <td>id</td>
95    /// <td>name</td>
96    /// <td>updated_at</td>
97    /// <td>created_at</td>
98    /// <td>description</td>
99    /// <td>homepage</td>
100    /// <td>documentation</td>
101    /// <td>readme</td>
102    /// <td>repository</td>
103    /// <td>max_upload_size</td>
104    /// <td>max_features</td>
105    /// </tr></table>
106    pub crates: Vec<crates::Row>,
107
108    /// <table style="width:initial"><tr>
109    /// <th>crates_categories.csv</th>
110    /// <td>crate_id</td>
111    /// <td>category_id</td>
112    /// </tr></table>
113    pub crates_categories: Vec<crates_categories::Row>,
114
115    /// <table style="width:initial"><tr>
116    /// <th>crates_keywords.csv</th>
117    /// <td>crate_id</td>
118    /// <td>keyword_id</td>
119    /// </tr></table>
120    pub crates_keywords: Vec<crates_keywords::Row>,
121
122    /// <table style="width:initial"><tr>
123    /// <th>default_versions.csv</th>
124    /// <td>crate_id</td>
125    /// <td>version_id</td>
126    /// <td>num_versions</td>
127    /// </tr></table>
128    pub default_versions: Vec<default_versions::Row>,
129
130    /// <table style="width:initial"><tr>
131    /// <th>dependencies.csv</th>
132    /// <td>id</td>
133    /// <td>version_id</td>
134    /// <td>crate_id</td>
135    /// <td>req</td>
136    /// <td>optional</td>
137    /// <td>default_features</td>
138    /// <td>features</td>
139    /// <td>target</td>
140    /// <td>kind</td>
141    /// <td>explicit_name</td>
142    /// </tr></table>
143    pub dependencies: Vec<dependencies::Row>,
144
145    /// <table style="width:initial"><tr>
146    /// <th>keywords.csv</th>
147    /// <td>id</td>
148    /// <td>keyword</td>
149    /// <td>crates_cnt</td>
150    /// <td>created_at</td>
151    /// </tr></table>
152    pub keywords: Vec<keywords::Row>,
153
154    /// <table style="width:initial"><tr>
155    /// <th>metadata.csv</th>
156    /// <td>total_downloads</td>
157    /// </tr></table>
158    pub metadata: metadata::Row,
159
160    /// <table style="width:initial"><tr>
161    /// <th>reserved_crate_names.csv</th>
162    /// <td>name</td>
163    /// </tr></table>
164    pub reserved_crate_names: Vec<reserved_crate_names::Row>,
165
166    /// <table style="width:initial"><tr>
167    /// <th>teams.csv</th>
168    /// <td>id</td>
169    /// <td>login</td>
170    /// <td>github_id</td>
171    /// <td>name</td>
172    /// <td>avatar</td>
173    /// <td>org_id</td>
174    /// </tr></table>
175    pub teams: Vec<teams::Row>,
176
177    /// <table style="width:initial"><tr>
178    /// <th>users.csv</th>
179    /// <td>id</td>
180    /// <td>gh_login</td>
181    /// <td>name</td>
182    /// <td>gh_avatar</td>
183    /// <td>gh_id</td>
184    /// </tr></table>
185    pub users: Vec<users::Row>,
186
187    /// <table style="width:initial"><tr>
188    /// <th>version_downloads.csv</th>
189    /// <td>version_id</td>
190    /// <td>downloads</td>
191    /// <td>date</td>
192    /// </tr></table>
193    pub version_downloads: Vec<version_downloads::Row>,
194
195    /// <table style="width:initial"><tr>
196    /// <th>versions.csv</th>
197    /// <td>id</td>
198    /// <td>crate_id</td>
199    /// <td>num</td>
200    /// <td>updated_at</td>
201    /// <td>created_at</td>
202    /// <td>downloads</td>
203    /// <td>features</td>
204    /// <td>yanked</td>
205    /// <td>license</td>
206    /// <td>crate_size</td>
207    /// <td>published_by</td>
208    /// <td>checksum</td>
209    /// <td>links</td>
210    /// <td>rust_version</td>
211    /// <td>has_lib</td>
212    /// <td>bin_names</td>
213    /// <td>edition</td>
214    /// <td>description</td>
215    /// <td>homepage</td>
216    /// <td>documentation</td>
217    /// <td>repository</td>
218    /// </tr></table>
219    pub versions: Vec<versions::Row>,
220}