Laravel DB Auditor

https://github.com/vcian/laravel-db-auditor
Admin
Laravel DB Auditor is a package that audits MySQL, SQLite, and PostgreSQL databases to evaluate...
Tokens:8,459
Snippets:52
Trust Score:7.8
License:MIT
Update:8 months ago
Show doc for...
Tokens:
Raw
### Install Laravel DB Auditor

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Installs the Laravel DB Auditor package as a development dependency using Composer.

```bash
composer require --dev vcian/laravel-db-auditor
```

--------------------------------

### Get Table Constraints via API

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Retrieves constraint information for a specified table using a GET request to the /api/gettableconstraint/{tableName} endpoint. The response includes details about primary keys, indexing, unique keys, and foreign keys for each column.

```bash
# Get constraint details for a table
curl -X GET "http://your-app.test/api/gettableconstraint/users"

# Response:
{
  "data": [
    {
      "column": "id",
      "primaryKey": "<img src='green-key.svg'/>",
      "indexing": "-",
      "uniqueKey": "-",
      "foreignKey": "-"
    },
    {
      "column": "email",
      "primaryKey": "-",
      "indexing": "-",
      "uniqueKey": "<img src='gray-key.svg'/>",
      "foreignKey": "-"
    }
  ]
}
```

--------------------------------

### Get Database Summary

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Retrieves and displays a summary of the database, including name, size, table count, version, and character set. The output format varies between MySQL and SQLite.

```bash
# Get database summary
php artisan db:summary

# Example output for MySQL:
# +---------------+----------+-------------+------------+---------------+ 
# | Database Name | Size (MB)| Table Count | DB Version | Character Set | 
# +---------------+----------+-------------+------------+---------------+ 
# | my_database   | 45.23    | 28          | 8.0.32     | utf8mb4       | 
# +---------------+----------+-------------+------------+---------------+ 

# Example output for SQLite:
# +------------------+---------------+-------------+--------------+--------------------+ 
# | Database Version | Database Name | Table Count | Busy Timeout | Default Cache Size | 
# +------------------+---------------+-------------+--------------+--------------------+ 
# | 1                | database.db   | 15          | 5000         | 2000 KB            | 
# +------------------+---------------+-------------+--------------+--------------------+ 

```

--------------------------------

### Get Database Connection Information (PHP)

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Provides global helper functions to retrieve details about the current database connection. It includes functions to get the connection driver, database name, and SQLite cache size. These functions are useful for conditional logic based on the database type or for specific database configurations.

```php
<?php

// Get the current database connection driver
$driver = connection_driver();
// Returns: 'mysql', 'sqlite', or 'pgsql'

// Get the current database name
$dbName = database_name();
// Returns: 'my_application_db'

// Get SQLite cache size (SQLite only)
$cacheSize = get_sqlite_database_cache_size();
// Returns: '2000 KB' or '500 Pages'

// Usage example in application code
if (connection_driver() === 'mysql') {
    // MySQL-specific logic
    $performanceReport = app(DatabaseAuditService::class)->getMySQLPerformanceReport();
} elseif (connection_driver() === 'sqlite') {
    // SQLite-specific logic
    $cacheInfo = get_sqlite_database_cache_size();
}

```

--------------------------------

### Get Table Constraints

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Retrieve constraint information for a specific table by providing the table name.

```APIDOC
## GET /api/gettableconstraint/{tableName}

### Description
Retrieve constraint information for a specific table.

### Method
GET

### Endpoint
/api/gettableconstraint/{tableName}

#### Path Parameters
- **tableName** (string) - Required - The name of the table to retrieve constraints for.

### Response
#### Success Response (200)
- **data** (array) - An array of constraint objects for each column.
  - **column** (string) - The name of the column.
  - **primaryKey** (string) - Indicates if the column is a primary key.
  - **indexing** (string) - Indicates if the column is indexed.
  - **uniqueKey** (string) - Indicates if the column has a unique key.
  - **foreignKey** (string) - Indicates if the column is a foreign key.

### Response Example
```json
{
  "data": [
    {
      "column": "id",
      "primaryKey": "<img src='green-key.svg'/>",
      "indexing": "-",
      "uniqueKey": "-",
      "foreignKey": "-"
    },
    {
      "column": "email",
      "primaryKey": "-",
      "indexing": "-",
      "uniqueKey": "<img src='gray-key.svg'/>",
      "foreignKey": "-"
    }
  ]
}
```
```

--------------------------------

### GET /api/getTableData/{tableName}

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Retrieves detailed standard compliance information for a specific table via the REST API.

```APIDOC
## GET /api/getTableData/{tableName}

### Description
Retrieves detailed standard compliance information for a specific table. This includes table comments, field data types, and any identified standard violations.

### Method
GET

### Endpoint
`/api/getTableData/{tableName}`

### Parameters
#### Path Parameters
- **tableName** (string) - Required - The name of the table for which to retrieve data.

### Request Example
```bash
curl -X GET "http://your-app.test/api/getTableData/users"
```

### Response
#### Success Response (200)
Returns a JSON object containing detailed information about the specified table, including its fields, data types, and any compliance issues.

#### Response Example
```json
{
  "data": {
    "table": "users",
    "table_comment": [],
    "fields": {
      "id": {
        "datatype": {"data_type": "bigint", "size": null}
      },
      "UserName": {
        "0": "Name should follow snake_case convention",
        "datatype": {"data_type": "varchar", "size": "255"}
      }
    }
  }
}
```
```

--------------------------------

### GET /api/getAudit

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Retrieves audit data for all tables in the database via the REST API.

```APIDOC
## GET /api/getAudit

### Description
Retrieves audit data for all tables in the database. This endpoint provides a summary of each table's status and size.

### Method
GET

### Endpoint
`/api/getAudit`

### Parameters
This endpoint does not require any parameters.

### Request Example
```bash
curl -X GET "http://your-app.test/api/getAudit"
```

### Response
#### Success Response (200)
Returns a JSON object containing an array of table audit data, where each object includes the table name, status indicator, and size.

#### Response Example
```json
{
  "data": [
    {
      "name": "users",
      "status": "<img src='check.svg'/>",
      "size": "1.23 MB"
    },
    {
      "name": "posts",
      "status": "<img src='close.svg'/>",
      "size": "0.45 MB"
    }
  ]
}
```
```

--------------------------------

### Get All Tables Audit Status via API (REST)

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Retrieve the audit status for all tables in the database via a REST API endpoint. This endpoint returns a JSON response containing table names, status indicators, and sizes.

```bash
curl -X GET "http://your-app.test/api/getAudit"
```

--------------------------------

### Get Specific Table Audit Details via API (REST)

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Retrieve detailed standard compliance information for a specific table via a REST API endpoint. This endpoint returns a JSON response with table details, comments, and field information.

```bash
curl -X GET "http://your-app.test/api/getTableData/users"
```

--------------------------------

### Run Main Audit Menu Command

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Executes the main `db:audit` Artisan command to access an interactive menu for various database auditing features.

```bash
php artisan db:audit
```

--------------------------------

### Programmatic Usage with Traits

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Demonstrates how to use the package's traits (Rules, DBFunctions, Audit) in custom PHP code for database auditing and management.

```APIDOC
## Programmatic Usage with Traits

### Description
The package traits can be used directly in your application code for custom auditing logic.

### Traits
- **Rules**: Provides methods for checking database rules and compliance.
- **DBFunctions**: Offers general database utility functions.
- **Audit**: Contains core auditing functionalities.

### Example Usage (PHP)
```php
<?php

namespace App\Services;

use Vcian\LaravelDBAuditor\Traits\Rules;
use Vcian\LaravelDBAuditor\Traits\DBFunctions;
use Vcian\LaravelDBAuditor\Traits\Audit;

class DatabaseAuditService
{
    use Rules, DBFunctions, Audit;

    public function auditAllTables(): array
    {
        // Get all tables with their standard compliance status
        $results = $this->allTablesRules();

        // Returns array of:
        // [
        //     ['name' => 'users', 'status' => true, 'size' => '1.23'],
        //     ['name' => 'posts', 'status' => false, 'size' => '0.45'],
        // ]

        return $results;
    }

    public function getTableDetails(string $tableName): array
    {
        // Check if table exists
        if (!$this->checkTableExist($tableName)) {
            return ['error' => 'Table not found'];
        }

        // Get comprehensive table audit
        $tableRules = $this->tableRules($tableName);

        // Get table fields
        $fields = $this->getFields($tableName);

        // Get table size
        $size = $this->getTableSize($tableName);

        // Get field details with data types
        $fieldDetails = $this->getFieldsDetails($tableName);

        return [
            'rules' => $tableRules,
            'fields' => $fields,
            'size' => $size,
            'details' => $fieldDetails,
        ];
    }

    public function addTableConstraint(
        string $table,
        string $field,
        string $constraint,
        ?string $refTable = null,
        ?string $refField = null
    ): bool {
        // Add constraint programmatically
        // Constraint types: PRIMARY, FOREIGN, UNIQUE, INDEX
        return $this->addConstraint($table, $field, $constraint, $refTable, $refField);
    }

    public function getMySQLPerformanceReport(): array
    {
        // Generate MySQL performance analysis
        return $this->generatePerformanceReport();

        // Returns:
        // [
        //     'innodb_buffer_pool_size' => [
        //         'current' => '134217728',
        //         'suggestion' => 'Consider increasing to at least 1GB'
        //     ],
        //     'max_connections' => [
        //         'current' => '151',
        //         'suggestion' => 'Current value seems appropriate'
        //     ],
        // ]
    }
}
```
```

--------------------------------

### Track Database Migrations

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Displays tracking information for database migration files, including creation date, affected tables, fields, migration status, and author. Can be filtered by table name.

```bash
# View all migration tracking information
php artisan db:track

# Filter by specific table name
php artisan db:track --table=users

```

--------------------------------

### php artisan db:check-performance-parameter

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Analyzes MySQL database performance parameters and provides optimization suggestions.

```APIDOC
## php artisan db:check-performance-parameter

### Description
Analyzes MySQL database performance parameters and provides optimization suggestions. This command is specific to MySQL.

### Method
Artisan Command

### Endpoint
N/A

### Parameters
This command does not accept any parameters.

### Request Example
```bash
php artisan db:check-performance-parameter
```

### Response
#### Success Response (Output)
Displays a table with performance parameters, their current values, and suggested optimizations.

#### Response Example
```
+------------------------+---------------+--------------------------------------------------------+
| Parameter              | Current Value | Suggestion                                             |
+------------------------+---------------+--------------------------------------------------------+
| innodb_buffer_pool_size| 128 MB        | Consider increasing to at least 1GB for better perf   |
| query_cache_size       | 0             | Query cache disabled. Consider enabling for read-heavy|
| max_connections        | 151           | Current value seems appropriate                        |
| innodb_log_file_size   | 48 MB         | Consider increasing for better performance             |
+------------------------+---------------+--------------------------------------------------------+
```

### Parameters Analyzed:
- **innodb_buffer_pool_size**: Should be 1GB+ for production.
- **query_cache_size**: Enable for read-heavy workloads.
- **max_connections**: 100-1000 range recommended.
- **innodb_log_file_size**: 128MB+ recommended.
```

--------------------------------

### Manage Database Constraints

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Provides an interface to view existing database constraints (PRIMARY, FOREIGN, UNIQUE, INDEX) and interactively add new ones. Note that adding constraints to existing tables is limited in SQLite, and not yet supported in PostgreSQL.

```bash
# Open constraint management interface
php artisan db:constraint

# The command displays:
# 1. List of all tables (excluding configured skip tables)
# 2. Select a table to view its constraints
# 3. Shows existing PRIMARY, FOREIGN, UNIQUE, and INDEX constraints
# 4. Option to add new constraints interactively

# Supported constraints:
# - PRIMARY: Add primary key to integer fields
# - FOREIGN: Add foreign key linking to another table
# - UNIQUE: Add unique constraint (validates no duplicates exist)
# - INDEX: Add index for query optimization

# Note: SQLite doesn't support adding PRIMARY/FOREIGN keys to existing tables
# Note: PostgreSQL constraint addition is not yet supported (view only)

```

--------------------------------

### Programmatic Database Auditing with Laravel DB Auditor Traits

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Demonstrates how to use the `Rules`, `DBFunctions`, and `Audit` traits from the Laravel DB Auditor package within custom PHP classes. This allows for direct integration of auditing logic, such as checking table compliance, retrieving table details, adding constraints, and generating performance reports, without relying solely on API calls.

```php
<?php

namespace App\Services;

use Vcian\LaravelDBAuditor\Traits\Rules;
use Vcian\LaravelDBAuditor\Traits\DBFunctions;
use Vcian\LaravelDBAuditor\Traits\Audit;

class DatabaseAuditService
{
    use Rules, DBFunctions, Audit;

    public function auditAllTables(): array
    {
        // Get all tables with their standard compliance status
        $results = $this->allTablesRules();

        // Returns array of:
        // [
        //     ['name' => 'users', 'status' => true, 'size' => '1.23'],
        //     ['name' => 'posts', 'status' => false, 'size' => '0.45'],
        // ]

        return $results;
    }

    public function getTableDetails(string $tableName): array
    {
        // Check if table exists
        if (!$this->checkTableExist($tableName)) {
            return ['error' => 'Table not found'];
        }

        // Get comprehensive table audit
        $tableRules = $this->tableRules($tableName);

        // Get table fields
        $fields = $this->getFields($tableName);

        // Get table size
        $size = $this->getTableSize($tableName);

        // Get field details with data types
        $fieldDetails = $this->getFieldsDetails($tableName);

        return [
            'rules' => $tableRules,
            'fields' => $fields,
            'size' => $size,
            'details' => $fieldDetails,
        ];
    }

    public function addTableConstraint(
        string $table,
        string $field,
        string $constraint,
        ?string $refTable = null,
        ?string $refField = null
    ): bool {
        // Add constraint programmatically
        // Constraint types: PRIMARY, FOREIGN, UNIQUE, INDEX
        return $this->addConstraint($table, $field, $constraint, $refTable, $refField);
    }

    public function getMySQLPerformanceReport(): array
    {
        // Generate MySQL performance analysis
        return $this->generatePerformanceReport();

        // Returns:
        // [
        //     'innodb_buffer_pool_size' => [
        //         'current' => '134217728',
        //         'suggestion' => 'Consider increasing to at least 1GB'
        //     ],
        //     'max_connections' => [
        //         'current' => '151',
        //         'suggestion' => 'Current value seems appropriate'
        //     ],
        // ]
    }
}

```

--------------------------------

### php artisan vendor:publish --tag=config

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Publishes the configuration file for Laravel DB Auditor, allowing customization of settings like skip tables.

```APIDOC
## php artisan vendor:publish --tag=config

### Description
Publishes the configuration file for the Laravel DB Auditor package. This allows you to customize various settings, including the list of tables to skip during auditing.

### Method
Artisan Command

### Endpoint
N/A

### Parameters
#### Query Parameters
- **--tag=config** (string) - Required - Specifies the tag to publish, which is 'config' for the configuration file.

### Request Example
```bash
php artisan vendor:publish --tag=config
```

### Response
#### Success Response (Output)
After running the command, you will be prompted to select the service provider to publish assets for. Choose 'db-auditor'. This will create the `config/db-auditor.php` file.

#### Response Example
```php
// config/db-auditor.php
return [
    'skip_tables' => [
        'cache',
        'sqlite_sequence',
        'migrations',
        'migrations_history',
        'sessions',
        'password_resets',
        'failed_jobs',
        'jobs',
        'queue_job',
        'queue_failed_jobs',
    ]
];
```

### Adding Tables to Skip List
To add custom tables to the skip list, modify the `skip_tables` array in the published `config/db-auditor.php` file.
```

--------------------------------

### Check Database Naming Standards

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Analyzes tables and columns for naming convention compliance, including snake_case, plural table names, name length, and character sets. Supports checking all tables or a specific table.

```bash
# Check standards for all tables
php artisan db:standard

# Check standards for a specific table
php artisan db:standard --table=users

# The command checks for:
# - Snake_case naming convention
# - Plural table names (e.g., "users" not "user")
# - Maximum name length (64 characters)
# - Alphabetic character sets (no special characters)
# - VARCHAR fields with size <= 255 (suggests using CHAR for PostgreSQL)

# Example output shows tables with status indicators:
# +-----------------+--------+--------+ 
# | Table Name      | Status | Size   | 
# +-----------------+--------+--------+ 
# | users           | ✓      | 1.2 MB | 
# | order_items     | ✓      | 0.5 MB | 
# | UserPreference  | ✗      | 0.1 MB | <- Not following snake_case
# +-----------------+--------+--------+ 

```

--------------------------------

### Add Foreign Key Constraint via API

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Facilitates adding foreign key constraints between tables. It involves endpoints to retrieve available tables for reference (/api/foreign-key-table) and fields from a reference table (/api/foreign-key-field/{tableName}). The actual foreign key is added via a POST request to /api/add-foreign-constraint with a JSON payload detailing the tables and fields involved. Returns true on success, with specific error messages for mismatches.

```bash
# Get available tables for foreign key reference
curl -X GET "http://your-app.test/api/foreign-key-table"

# Response: ["users", "posts", "categories", "tags"]

# Get fields from a reference table
curl -X GET "http://your-app.test/api/foreign-key-field/users"

# Response: [{"COLUMN_NAME": "id"}, {"COLUMN_NAME": "email"}]

# Add foreign key constraint
curl -X POST "http://your-app.test/api/add-foreign-constraint" \
  -H "Content-Type: application/json" \
  -d '{
    "table_name": "posts",
    "select_field": "user_id",
    "reference_table": "users",
    "reference_field": "id"
  }'

# Response: true (on success)
# Error responses:
# - "Foreign table and selected table should not be same"
# - "Foreign key not applied due to datatype mismatch"
```

--------------------------------

### Generate MySQL Performance Report (PHP)

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Generate a MySQL database performance analysis report with optimization suggestions using the 'db:check-performance-parameter' Artisan command. This command is specific to MySQL.

```bash
php artisan db:check-performance-parameter
```

--------------------------------

### php artisan vendor:publish --tag=public

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Publishes public assets for the Laravel DB Auditor web interface, making it accessible via a URL.

```APIDOC
## php artisan vendor:publish --tag=public

### Description
Publishes the public assets required for the Laravel DB Auditor web interface. This makes the web UI accessible through your application's URL.

### Method
Artisan Command

### Endpoint
N/A

### Parameters
#### Query Parameters
- **--tag=public** (string) - Required - Specifies the tag to publish, which is 'public' for the web UI assets.

### Request Example
```bash
php artisan vendor:publish --tag=public
```

### Response
#### Success Response (Output)
After running the command, you will be prompted to select the service provider to publish assets for. Choose 'db-auditor'. This will publish the necessary assets to your public directory.

#### Response Example
Access the web interface at:
`http://your-app.test/laravel-db-auditor`

The web UI provides:
- Visual table listing with status indicators.
- Interactive standard checking with detailed reports.
- Constraint viewing and management.
- Click-to-add constraint functionality for MySQL.
```

--------------------------------

### Publish DB Auditor Configuration (PHP)

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Publish the Laravel DB Auditor configuration file to customize settings like skipped tables. This is done using the 'vendor:publish' Artisan command with the 'config' tag.

```bash
php artisan vendor:publish --tag=config
```

--------------------------------

### Publish DB Auditor Web UI Assets (PHP)

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Publish the public assets for the Laravel DB Auditor web interface using the 'vendor:publish' Artisan command with the 'public' tag. This makes the web UI accessible.

```bash
php artisan vendor:publish --tag=public
```

--------------------------------

### Add Constraint via API

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Add a constraint (PRIMARY, INDEX, UNIQUE) to a table column programmatically.

```APIDOC
## POST /api/change-constraint

### Description
Add a constraint (PRIMARY, INDEX, UNIQUE) to a table column programmatically.

### Method
POST

### Endpoint
/api/change-constraint

#### Request Body
- **table_name** (string) - Required - The name of the table.
- **colum_name** (string) - Required - The name of the column.
- **constraint** (string) - Required - The type of constraint to add (PRIMARY, INDEX, UNIQUE).

### Request Example
```json
{
  "table_name": "posts",
  "colum_name": "slug",
  "constraint": "UNIQUE"
}
```

### Response
#### Success Response (200)
- **true** (boolean) - Indicates success.

#### Error Response
- **false** (boolean) - Indicates failure.
```

--------------------------------

### php artisan db:track

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Track database changes by filtering by action type (create/update) or migration status (pending/migrated).

```APIDOC
## php artisan db:track

### Description
Tracks database changes, allowing filtering by action type (create or update) and migration status (pending or migrated).

### Method
Artisan Command

### Endpoint
N/A

### Parameters
#### Query Parameters
- **--action** (string) - Optional - Filters by action type. Accepts 'create' or 'c' for create, 'update' or 'u' for update.
- **--status** (string) - Optional - Filters by migration status. Accepts 'pending' or 'p' for pending, 'migrated' or 'm' for migrated.

### Request Example
```bash
php artisan db:track --action=create
php artisan db:track --status=pending
```

### Response
#### Success Response (Output)
Displays a table with audit information including Date, File Name, Table, Fields, Action, Status, and Created By.

#### Response Example
```
+------------+--------------------------------+--------+------------------+--------+----------+------------+
| Date       | File Name                      | Table  | Fields           | Action | Status   | Created By |
+------------+--------------------------------+--------+------------------+--------+----------+------------+
| 2024-01-15 | 2024_01_15_000000_create_users | users  | id, name, email  | Create | Migrated | john_doe   |
| 2024-01-20 | 2024_01_20_000000_add_role     | users  | role_id          | Update | Pending  | jane_smith |
+------------+--------------------------------+--------+------------------+--------+----------+------------+
```
```

--------------------------------

### Add Foreign Key Constraint

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Add a foreign key constraint linking two tables. Includes endpoints to retrieve available tables and fields for reference.

```APIDOC
## GET /api/foreign-key-table

### Description
Retrieve a list of available tables that can be used as a reference for a foreign key constraint.

### Method
GET

### Endpoint
/api/foreign-key-table

### Response
#### Success Response (200)
- **[string]** - An array of table names.

### Response Example
```json
["users", "posts", "categories", "tags"]
```

## GET /api/foreign-key-field/{tableName}

### Description
Retrieve a list of fields from a specified reference table that can be used for a foreign key constraint.

### Method
GET

### Endpoint
/api/foreign-key-field/{tableName}

#### Path Parameters
- **tableName** (string) - Required - The name of the table to retrieve fields from.

### Response
#### Success Response (200)
- **[object]** - An array of field objects.
  - **COLUMN_NAME** (string) - The name of the column.

### Response Example
```json
[{"COLUMN_NAME": "id"}, {"COLUMN_NAME": "email"}]
```

## POST /api/add-foreign-constraint

### Description
Add a foreign key constraint linking a column in one table to a column in another table.

### Method
POST

### Endpoint
/api/add-foreign-constraint

#### Request Body
- **table_name** (string) - Required - The name of the table to add the foreign key to.
- **select_field** (string) - Required - The name of the column in `table_name` to add the foreign key to.
- **reference_table** (string) - Required - The name of the table to reference.
- **reference_field** (string) - Required - The name of the column in `reference_table` to reference.

### Request Example
```json
{
  "table_name": "posts",
  "select_field": "user_id",
  "reference_table": "users",
  "reference_field": "id"
}
```

### Response
#### Success Response (200)
- **true** (boolean) - Indicates success.

#### Error Responses
- **"Foreign table and selected table should not be same"** (string)
- **"Foreign key not applied due to datatype mismatch"** (string)
```

--------------------------------

### Filter DB Audit by Migration Status (PHP)

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Filter database audit logs by migration status (pending or migrated) using the 'db:track' Artisan command. Supports full and short forms for status types.

```bash
php artisan db:track --status=pending
php artisan db:track --status=p
php artisan db:track --status=migrated
php artisan db:track --status=m
```

--------------------------------

### Configure Skipped Tables in DB Auditor (PHP)

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Modify the 'skip_tables' array in the published 'config/db-auditor.php' file to exclude specific tables from auditing. This allows for customization of which tables are monitored.

```php
// config/db-auditor.php
return [
    'skip_tables' => [
        // Default Laravel tables
        'cache',
        'migrations',
        'sessions',
        'password_resets',
        'failed_jobs',
        'jobs',

        // Add your custom tables to skip
        'telescope_entries',
        'telescope_monitoring',
        'audit_logs',
        'temp_data',
    ]
];
```

--------------------------------

### Add Table Constraint via API

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Adds a constraint (PRIMARY, INDEX, UNIQUE, FOREIGN) to a table column using a POST request to the /api/change-constraint endpoint. Requires a JSON payload specifying the table name, column name, and the desired constraint type. Returns true on success.

```bash
# Add a constraint (PRIMARY, INDEX, UNIQUE)
curl -X POST "http://your-app.test/api/change-constraint" \
  -H "Content-Type: application/json" \
  -d '{
    "table_name": "posts",
    "colum_name": "slug",
    "constraint": "UNIQUE"
  }'

# Response: true (on success)

# Constraint values: PRIMARY, INDEX, UNIQUE, FOREIGN
```

--------------------------------

### Filter DB Audit by Action Type (PHP)

Source: https://context7.com/vcian/laravel-db-auditor/llms.txt

Filter database audit logs by action type (create or update) using the 'db:track' Artisan command. Supports full and short forms for action types.

```bash
php artisan db:track --action=create
php artisan db:track --action=c
```
Tokens:
Raw