import {Callout} from "nextra-theme-docs"; import {OptionTable} from "../../components/env-table"; import Image from 'next/image';

Database Commands

Database commands provides tooling to manage and inspect your databases.

Command Reference Table

export const columns = [ { key: 'command', header: 'Command', headerClassName: '', cellClassName: 'whitespace-pre py-2 font-mono text-xs font-semibold leading-6 text-violet-600 dark:text-violet-500' }, { key: 'description', header: 'Description', headerClassName: 'px-6', cellClassName: 'py-2 pl-6', } ]

export const commands = [ ["cycle:db:list", "Get list of available databases, their tables and records count."], ["cycle:db:table", "Describe table schema of specific database"], ];

<OptionTable options={commands.map(([command, description]) => ({ command, description }))} columns={columns} />

Listing Databases

cycle:db:list

This command provides a comprehensive list of all databases, along with their tables and the count of records in each table.

Usage

php artisan cycle:db:list

Example

Describing Table Schema

cycle:db:table

To get detailed information about the schema of a specific table, use the cycle:db:table command. This includes column names, types, and other relevant metadata.

Usage

php artisan cycle:db:table your_table_name

Options

--d|database: The name of the database to use. If not provided, the default database will be used.

Example