sqlx-gen 0.1.0

Generate Rust structs from database schema introspection
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# sqlx-gen

Generate Rust structs from your database schema — with correct types, derives, and `sqlx::FromRow` annotations.

Supports **PostgreSQL**, **MySQL**, and **SQLite**. Introspects tables, enums, composite types, and domains.

[![Crates.io](https://img.shields.io/crates/v/sqlx-gen.svg)](https://crates.io/crates/sqlx-gen)
[![docs.rs](https://docs.rs/sqlx-gen/badge.svg)](https://docs.rs/sqlx-gen)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

## Features

- Multi-database: PostgreSQL, MySQL, SQLite
- Multi-schema support (PostgreSQL)
- Generates `#[derive(sqlx::FromRow)]` structs
- PostgreSQL enums → `#[derive(sqlx::Type)]` enums
- PostgreSQL composite types and domains
- MySQL inline ENUM detection
- Correct nullable handling (`Option<T>`)
- Custom derives (`--derives Serialize,Deserialize`)
- Type overrides (`--type-overrides jsonb=MyType`)
- Table filtering (`--tables users,orders`)
- Single-file or multi-file output
- Dry-run mode (preview on stdout)

## Installation

```sh
cargo install sqlx-gen
```

## Usage

### PostgreSQL (multi-schema)
```sh
sqlx-gen -u postgres://user:pass@localhost/mydb -s public,auth -o src/models
```

### MySQL
```sh
sqlx-gen -u mysql://user:pass@localhost/mydb -o src/models
```

### SQLite
```sh
sqlx-gen -u sqlite:./local.db -o src/models
```

### With extra derives
```sh
sqlx-gen -u postgres://... --derives Serialize,Deserialize -o src/models
```

### Dry run (preview without writing)
```sh
sqlx-gen -u postgres://... --dry-run
```

## CLI Options

| Flag | Short | Description | Default |
|------|-------|-------------|---------|
| `--database-url` | `-u` | Database connection URL (or `DATABASE_URL` env) | required |
| `--output-dir` | `-o` | Output directory | `src/models` |
| `--schemas` | `-s` | Schemas to introspect (comma-separated) | `public` |
| `--derives` | | Additional derive macros (comma-separated) | none |
| `--type-overrides` | | Type overrides `sql_type=RustType` (comma-separated) | none |
| `--tables` | | Only generate these tables (comma-separated) | all |
| `--single-file` | | Write everything to a single `models.rs` | false |
| `--dry-run` | | Print to stdout, don't write files | false |

## Example Output

```rust
// Auto-generated by sqlx-gen. Do not edit.
// Table: public.users

use chrono::{DateTime, Utc};
use uuid::Uuid;

#[derive(Debug, Clone, sqlx::FromRow)]
pub struct Users {
    pub id: Uuid,
    pub email: String,
    pub name: Option<String>,
    pub created_at: DateTime<Utc>,
}
```

Enums:
```rust
#[derive(Debug, Clone, PartialEq, sqlx::Type)]
#[sqlx(type_name = "status")]
pub enum Status {
    #[sqlx(rename = "active")]
    Active,

    #[sqlx(rename = "inactive")]
    Inactive,
}
```

## License

MIT