id = "typeorm" name = "TypeORM CLI" description = "Command-line interface of the TypeORM object-relational mapper." homepage = "https://typeorm.io" executables = ["typeorm"] [commands] format = 1 label = "TypeORM" description = "Run schema and migration commands against a configured connection." quality = "ai-draft" base = "fig:typeorm" parser = { end_of_options = "--", interleave = "permute", long_equals = false, short_attached = true, short_bundles = false } [[commands.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/typeorm.ts" license = "MIT" [[commands.subcommand]] path = ["migration:run"] label = "Run migrations" description = "Run all pending migrations." [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/typeorm.ts" license = "MIT" [[commands.subcommand.field]] id = "connection" label = "Connection name" type = "string" option = ["--connection", "-c"] sources = ["fig"] [[commands.subcommand.field]] id = "config" label = "Connection config file" type = "path" option = ["--config", "-f"] path = { kind = "file", role = "input" } sources = ["fig"] [[commands.subcommand.field]] id = "transaction" label = "Use a transaction" type = "boolean" option = ["--transaction", "-t"] sources = ["fig"] [[commands.subcommand.task]] id = "run" label = "Run pending migrations" fields = ["config", "connection", "transaction"] required = ["config"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["connection", "config", "transaction"] [[commands.subcommand]] path = ["migration:revert"] label = "Revert migration" description = "Revert the last executed migration." [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/typeorm.ts" license = "MIT" [[commands.subcommand.field]] id = "connection" label = "Connection name" type = "string" option = ["--connection", "-c"] sources = ["fig"] [[commands.subcommand.field]] id = "config" label = "Connection config file" type = "path" option = ["--config", "-f"] path = { kind = "file", role = "input" } sources = ["fig"] [[commands.subcommand.field]] id = "transaction" label = "Use a transaction" type = "boolean" option = ["--transaction", "-t"] sources = ["fig"] [[commands.subcommand.task]] id = "revert" label = "Revert last migration" fields = ["config", "connection", "transaction"] required = ["config"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["connection", "config", "transaction"] [[commands.subcommand]] path = ["migration:show"] label = "Show migrations" description = "List migrations and whether they ran." [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/typeorm.ts" license = "MIT" [[commands.subcommand.field]] id = "connection" label = "Connection name" type = "string" option = ["--connection", "-c"] sources = ["fig"] [[commands.subcommand.field]] id = "config" label = "Connection config file" type = "path" option = ["--config", "-f"] path = { kind = "file", role = "input" } sources = ["fig"] [[commands.subcommand.task]] id = "show" label = "Show migrations" fields = ["config", "connection"] required = ["config"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["connection", "config"] [[commands.subcommand]] path = ["migration:generate"] label = "Generate migration" description = "Create a migration from schema differences." [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/typeorm.ts" license = "MIT" [[commands.subcommand.field]] id = "name" label = "Migration name" type = "string" option = ["--name", "-n"] sources = ["fig"] [[commands.subcommand.field]] id = "connection" label = "Connection name" type = "string" option = ["--connection", "-c"] sources = ["fig"] [[commands.subcommand.field]] id = "config" label = "Connection config file" type = "path" option = ["--config", "-f"] path = { kind = "file", role = "input" } sources = ["fig"] [[commands.subcommand.field]] id = "dir" label = "Output directory" type = "path" option = ["--dir", "-d"] path = { kind = "directory", role = "output" } sources = ["fig"] [[commands.subcommand.field]] id = "pretty" label = "Pretty-print SQL" type = "boolean" option = ["--pretty", "-p"] sources = ["fig"] [[commands.subcommand.field]] id = "output_js" label = "JavaScript output" type = "boolean" option = ["--outputJs", "-o"] sources = ["fig"] [[commands.subcommand.field]] id = "dryrun" label = "Dry run" type = "boolean" option = ["--dryrun", "--dr"] sources = ["fig"] [[commands.subcommand.task]] id = "generate" label = "Generate migration" fields = ["name", "config", "dir", "pretty"] required = ["name", "config"] [[commands.subcommand.task]] id = "preview" label = "Preview only" set = { dryrun = [true] } fields = ["name", "config", "dryrun"] required = ["name", "config"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["name", "connection", "config", "dir", "pretty"] [[commands.subcommand.group]] id = "advanced" label = "Advanced" fields = ["output_js", "dryrun"] [[commands.subcommand]] path = ["schema:sync"] label = "Sync schema" description = "Synchronize entities with the database schema; this can alter or drop tables." [[commands.subcommand.source]] id = "fig" kind = "completion" url = "https://github.com/withfig/autocomplete/blob/master/src/typeorm.ts" license = "MIT" [[commands.subcommand.field]] id = "connection" label = "Connection name" type = "string" option = ["--connection", "-c"] sources = ["fig"] [[commands.subcommand.field]] id = "config" label = "Connection config file" type = "path" option = ["--config", "-f"] path = { kind = "file", role = "input" } sources = ["fig"] [[commands.subcommand.task]] id = "sync" label = "Sync schema" fields = ["config", "connection"] required = ["config"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["connection", "config"]