ride/cli-database

Database commands for the Ride CLI

Ride: Database CLI

This module adds various database commands to the Ride CLI., _(*1)

Commands

database

This command shows an overview of the database connections in the manager., _(*2)

Syntax: database, _(*3)

Alias: db, _(*4)

database convert utf8

This command converts all tables from the provided database connection to UTF-8., _(*5)

Syntax: database convert utf8 <name> - <name>: Name of the connection, _(*6)

Alias: dbutf8, _(*7)

database create

This command creates the database on the server of the connection if it does not exist., _(*8)

Syntax: database create [<name> [<charset> [<collation>]]] - <name>: Name of the connection - <charset>: Default charset for the database (default utf8) - <collation>: Default collation for the database (default utf8_general_ci), _(*9)

Alias: dbc, _(*10)

database default

This command gets or sets the name of the default database connection., _(*11)

Syntax: database default <name> - <name>: Name of the connection, _(*12)

Alias: dbdef, _(*13)

database drop

This command drops the database on the server of the connection if it exists., _(*14)

Syntax: database drop <name> - <name>: Name of the connection, _(*15)

Alias: dbdr, _(*16)

database add

This command registers a database connection in the manager., _(*17)

Syntax: database add <name> <dsn> - <name>: Name for the connection - <dsn>: DSN of the connection (protocol://username:password@host:port/database), _(*18)

Alias: dba, _(*19)

database status

This command gets the status of a connection., _(*20)

Syntax: database status [<name>] - <name>: Name of the connection, _(*21)

Alias: dbs, _(*22)

database delete

This command unregisters a database connection from the manager., _(*23)

Syntax: database delete <name> - <name>: Name for the connection, _(*24)

Alias: dbd, _(*25)

database driver

This command shows an overview of the available database drivers., _(*26)

Syntax: database driver, _(*27)

database query

This command executes a SQL query on the default database connection., _(*28)

Syntax: database query [--connection] [<sql>] - --connection: Name of the connection to use - <sql>: The SQL script to execute, _(*29)

Alias: dbq or query, _(*30)

Related Modules

• ride/app
• ride/app-database
• ride/cli
• ride/lib-cli
• ride/lib-database
• ride/lib-log

Installation

You can use Composer to install this application., _(*31)

composer require ride/cli-database