f6c9d81918
* Moving clap to vesion 4 * Moving the sea-orm-migration cli to clap v4 * Removing the deprecated flag from clapv4 * Upgrade clap to 4.3 * Fixup * . * Try compile [CLI] --------- Co-authored-by: aadi58002 <aadi58002gmail.com> Co-authored-by: Billy Chan <ccw.billy.123@gmail.com>
295 lines
9.0 KiB
Rust
295 lines
9.0 KiB
Rust
use clap::{ArgGroup, Parser, Subcommand, ValueEnum};
|
|
|
|
#[derive(Parser, Debug)]
|
|
#[command(
|
|
version,
|
|
author,
|
|
help_template = r#"{before-help}{name} {version}
|
|
{about-with-newline}
|
|
|
|
{usage-heading} {usage}
|
|
|
|
{all-args}{after-help}
|
|
|
|
AUTHORS:
|
|
{author}
|
|
"#,
|
|
about = r#"
|
|
____ ___ ____ __ __ /\
|
|
/ ___| ___ __ _ / _ \ | _ \ | \/ | {.-}
|
|
\___ \ / _ \ / _` || | | || |_) || |\/| | ;_.-'\
|
|
___) || __/| (_| || |_| || _ < | | | | { _.}_
|
|
|____/ \___| \__,_| \___/ |_| \_\|_| |_| \.-' / `,
|
|
\ | /
|
|
An async & dynamic ORM for Rust \ | ,/
|
|
=============================== \|_/
|
|
|
|
Getting Started!
|
|
- documentation: https://www.sea-ql.org/SeaORM
|
|
- step-by-step tutorials: https://www.sea-ql.org/sea-orm-tutorial
|
|
- integration examples: https://github.com/SeaQL/sea-orm/tree/master/examples
|
|
- cookbook: https://www.sea-ql.org/sea-orm-cookbook
|
|
|
|
Join our Discord server to chat with others in the SeaQL community!
|
|
- invitation link: https://discord.com/invite/uCPdDXzbdv
|
|
|
|
If you like what we do, consider starring, commenting, sharing and contributing!
|
|
"#
|
|
)]
|
|
pub struct Cli {
|
|
#[arg(global = true, short, long, help = "Show debug messages")]
|
|
pub verbose: bool,
|
|
|
|
#[command(subcommand)]
|
|
pub command: Commands,
|
|
}
|
|
|
|
#[derive(Subcommand, PartialEq, Eq, Debug)]
|
|
pub enum Commands {
|
|
#[command(
|
|
about = "Codegen related commands",
|
|
arg_required_else_help = true,
|
|
display_order = 10
|
|
)]
|
|
Generate {
|
|
#[command(subcommand)]
|
|
command: GenerateSubcommands,
|
|
},
|
|
#[command(about = "Migration related commands", display_order = 20)]
|
|
Migrate {
|
|
#[arg(
|
|
global = true,
|
|
short = 'd',
|
|
long,
|
|
help = "Migration script directory.
|
|
If your migrations are in their own crate,
|
|
you can provide the root of that crate.
|
|
If your migrations are in a submodule of your app,
|
|
you should provide the directory of that submodule.",
|
|
default_value = "./migration"
|
|
)]
|
|
migration_dir: String,
|
|
|
|
#[arg(
|
|
global = true,
|
|
short = 's',
|
|
long,
|
|
env = "DATABASE_SCHEMA",
|
|
long_help = "Database schema\n \
|
|
- For MySQL and SQLite, this argument is ignored.\n \
|
|
- For PostgreSQL, this argument is optional with default value 'public'.\n"
|
|
)]
|
|
database_schema: Option<String>,
|
|
|
|
#[arg(
|
|
global = true,
|
|
short = 'u',
|
|
long,
|
|
env = "DATABASE_URL",
|
|
help = "Database URL"
|
|
)]
|
|
database_url: Option<String>,
|
|
|
|
#[command(subcommand)]
|
|
command: Option<MigrateSubcommands>,
|
|
},
|
|
}
|
|
|
|
#[derive(Subcommand, PartialEq, Eq, Debug)]
|
|
pub enum MigrateSubcommands {
|
|
#[command(about = "Initialize migration directory", display_order = 10)]
|
|
Init,
|
|
#[command(about = "Generate a new, empty migration", display_order = 20)]
|
|
Generate {
|
|
#[arg(required = true, help = "Name of the new migration")]
|
|
migration_name: String,
|
|
|
|
#[arg(
|
|
long,
|
|
default_value = "true",
|
|
help = "Generate migration file based on Utc time",
|
|
conflicts_with = "local_time",
|
|
display_order = 1001
|
|
)]
|
|
universal_time: bool,
|
|
|
|
#[arg(
|
|
long,
|
|
help = "Generate migration file based on Local time",
|
|
conflicts_with = "universal_time",
|
|
display_order = 1002
|
|
)]
|
|
local_time: bool,
|
|
},
|
|
#[command(
|
|
about = "Drop all tables from the database, then reapply all migrations",
|
|
display_order = 30
|
|
)]
|
|
Fresh,
|
|
#[command(
|
|
about = "Rollback all applied migrations, then reapply all migrations",
|
|
display_order = 40
|
|
)]
|
|
Refresh,
|
|
#[command(about = "Rollback all applied migrations", display_order = 50)]
|
|
Reset,
|
|
#[command(about = "Check the status of all migrations", display_order = 60)]
|
|
Status,
|
|
#[command(about = "Apply pending migrations", display_order = 70)]
|
|
Up {
|
|
#[arg(short, long, help = "Number of pending migrations to apply")]
|
|
num: Option<u32>,
|
|
},
|
|
#[command(about = "Rollback applied migrations", display_order = 80)]
|
|
Down {
|
|
#[arg(
|
|
short,
|
|
long,
|
|
default_value = "1",
|
|
help = "Number of applied migrations to be rolled back",
|
|
display_order = 90
|
|
)]
|
|
num: u32,
|
|
},
|
|
}
|
|
|
|
#[derive(Subcommand, PartialEq, Eq, Debug)]
|
|
pub enum GenerateSubcommands {
|
|
#[command(about = "Generate entity")]
|
|
#[command(group(ArgGroup::new("formats").args(&["compact_format", "expanded_format"])))]
|
|
#[command(group(ArgGroup::new("group-tables").args(&["tables", "include_hidden_tables"])))]
|
|
Entity {
|
|
#[arg(long, help = "Generate entity file of compact format")]
|
|
compact_format: bool,
|
|
|
|
#[arg(long, help = "Generate entity file of expanded format")]
|
|
expanded_format: bool,
|
|
|
|
#[arg(
|
|
long,
|
|
help = "Generate entity file for hidden tables (i.e. table name starts with an underscore)"
|
|
)]
|
|
include_hidden_tables: bool,
|
|
|
|
#[arg(
|
|
short = 't',
|
|
long,
|
|
value_delimiter = ',',
|
|
help = "Generate entity file for specified tables only (comma separated)"
|
|
)]
|
|
tables: Vec<String>,
|
|
|
|
#[arg(
|
|
long,
|
|
value_delimiter = ',',
|
|
default_value = "seaql_migrations",
|
|
help = "Skip generating entity file for specified tables (comma separated)"
|
|
)]
|
|
ignore_tables: Vec<String>,
|
|
|
|
#[arg(
|
|
long,
|
|
default_value = "1",
|
|
help = "The maximum amount of connections to use when connecting to the database."
|
|
)]
|
|
max_connections: u32,
|
|
|
|
#[arg(
|
|
short = 'o',
|
|
long,
|
|
default_value = "./",
|
|
help = "Entity file output directory"
|
|
)]
|
|
output_dir: String,
|
|
|
|
#[arg(
|
|
short = 's',
|
|
long,
|
|
env = "DATABASE_SCHEMA",
|
|
default_value = "public",
|
|
long_help = "Database schema\n \
|
|
- For MySQL, this argument is ignored.\n \
|
|
- For PostgreSQL, this argument is optional with default value 'public'."
|
|
)]
|
|
database_schema: String,
|
|
|
|
#[arg(short = 'u', long, env = "DATABASE_URL", help = "Database URL")]
|
|
database_url: String,
|
|
|
|
#[arg(
|
|
long,
|
|
default_value = "none",
|
|
help = "Automatically derive serde Serialize / Deserialize traits for the entity (none, \
|
|
serialize, deserialize, both)"
|
|
)]
|
|
with_serde: String,
|
|
|
|
#[arg(
|
|
long,
|
|
help = "Generate a serde field attribute, '#[serde(skip_deserializing)]', for the primary key fields to skip them during deserialization, this flag will be affective only when '--with-serde' is 'both' or 'deserialize'"
|
|
)]
|
|
serde_skip_deserializing_primary_key: bool,
|
|
|
|
#[arg(
|
|
long,
|
|
default_value = "false",
|
|
help = "Opt-in to add skip attributes to hidden columns (i.e. when 'with-serde' enabled and column name starts with an underscore)"
|
|
)]
|
|
serde_skip_hidden_column: bool,
|
|
|
|
#[arg(
|
|
long,
|
|
default_value = "false",
|
|
long_help = "Automatically derive the Copy trait on generated enums.\n\
|
|
Enums generated from a database don't have associated data by default, and as such can \
|
|
derive Copy.
|
|
"
|
|
)]
|
|
with_copy_enums: bool,
|
|
|
|
#[arg(
|
|
long,
|
|
default_value_t,
|
|
value_enum,
|
|
help = "The datetime crate to use for generating entities."
|
|
)]
|
|
date_time_crate: DateTimeCrate,
|
|
|
|
#[arg(
|
|
long,
|
|
short = 'l',
|
|
default_value = "false",
|
|
help = "Generate index file as `lib.rs` instead of `mod.rs`."
|
|
)]
|
|
lib: bool,
|
|
|
|
#[arg(
|
|
long,
|
|
value_delimiter = ',',
|
|
help = "Add extra derive macros to generated model struct (comma separated), e.g. `--model-extra-derives 'ts_rs::Ts','CustomDerive'`"
|
|
)]
|
|
model_extra_derives: Vec<String>,
|
|
|
|
#[arg(
|
|
long,
|
|
value_delimiter = ',',
|
|
help = r#"Add extra attributes to generated model struct, no need for `#[]` (comma separated), e.g. `--model-extra-attributes 'serde(rename_all = "camelCase")','ts(export)'`"#
|
|
)]
|
|
model_extra_attributes: Vec<String>,
|
|
|
|
#[arg(
|
|
long,
|
|
default_value = "false",
|
|
long_help = "Generate helper Enumerations that are used by Seaography."
|
|
)]
|
|
seaography: bool,
|
|
},
|
|
}
|
|
|
|
#[derive(Copy, Clone, Debug, PartialEq, Eq, ValueEnum, Default)]
|
|
pub enum DateTimeCrate {
|
|
#[default]
|
|
Chrono,
|
|
Time,
|
|
}
|