Database_CommandclassPro only

Database_Command

Database management commands for Top 10.

EXAMPLES

# Show status of all four Top 10 tables
$ wp top10 db status

# Create any missing tables
$ wp top10 db create-tables

# Prune old data (dry run)
$ wp top10 db prune --dry-run

# Roll up hourly rows older than 14 days (dry run)
$ wp top10 db rollup --dry-run

Namespace: WebberZone\Top_Ten\Pro\CLI
Since: 4.3.0
Source: includes/pro/cli/class-database-command.php line 39 Extends: Base_Command

Methods

status()

Show database status for all four Top 10 tables.

OPTIONS

[–format=] : Output format (table, json, csv). Default: table.

[–network] : Show status for all sites in the network.

[–blog-id=] : Specific blog ID to show status for (multisite only).

EXAMPLES

wp top10 db status
wp top10 db status --format=json
wp top10 db status --network

Line: 64

public function status( array $args, array $assoc_args ): void;

Returns: void

create_tables()

Create any missing Top 10 tables using dbDelta.

OPTIONS

[–dry-run] : Show what would be created without making changes.

[–network] : Create tables for all sites in the network.

[–blog-id=] : Specific blog ID to create tables for (multisite only).

EXAMPLES

wp top10 db create-tables
wp top10 db create-tables --dry-run
wp top10 db create-tables --network

Line: 108

public function create_tables( array $args, array $assoc_args ): void;

Returns: void

update_tables()

Apply schema upgrades via dbDelta (same as plugin activation).

OPTIONS

[–dry-run] : Show what would happen without making changes.

[–network] : Apply schema upgrades for all sites in the network.

[–blog-id=] : Specific blog ID to upgrade (multisite only).

EXAMPLES

wp top10 db update-tables
wp top10 db update-tables --dry-run
wp top10 db update-tables --network

Line: 157

public function update_tables( array $args, array $assoc_args ): void;

Returns: void

recreate_tables()

Recreate Top 10 tables with optional backup.

OPTIONS

[–table=

[–no-backup] : Skip creating a backup table before recreating.

[–force] : Skip interactive confirmation.

[–dry-run] : Show what would happen without making changes.

[–network] : Recreate tables for all sites in the network.

[–blog-id=] : Specific blog ID to recreate tables for (multisite only).

EXAMPLES

wp top10 db recreate-tables
wp top10 db recreate-tables --table=daily --no-backup
wp top10 db recreate-tables --table=funnel --force
wp top10 db recreate-tables --table=log --force
wp top10 db recreate-tables --force --dry-run
wp top10 db recreate-tables --network

Line: 218

public function recreate_tables( array $args, array $assoc_args ): void;

Returns: void

rollup()

Collapse old hourly daily rows into one row per post and calendar date.

OPTIONS

[–before=] : Roll up rows older than this many days. Default: 14.

[–force] : Skip the confirmation required for this data-changing operation.

[–dry-run] : Show exact row counts before and after the rollup without writing data.

[–network] : Roll up daily rows for all sites in the network.

[–blog-id=] : Roll up daily rows for a specific blog (multisite only).

EXAMPLES

wp top10 db rollup --dry-run
wp top10 db rollup --before=30 --dry-run
wp top10 db rollup --before=14 --force
wp top10 db rollup --network --dry-run

Since: 4.5.0
Line: 318

public function rollup( array $args, array $assoc_args ): void;

Returns: void

prune()

Prune old rows from the daily and/or visits log table.

OPTIONS

[–days=] : Retention period in days for the daily table. Default: tptn_maintenance_days filter or 180.

[–log-days=] : Retention period in days for the visits log table. Default: tptn_log_retention_days filter or 30.

[–table=

[–batch-size=] : Number of rows to delete per iteration. Default: 1000.

[–force] : Skip interactive confirmation.

[–dry-run] : Show counts without deleting.

[–network] : Prune for all sites in the network.

[–blog-id=] : Specific blog ID to prune (multisite only).

EXAMPLES

wp top10 db prune
wp top10 db prune --days=90 --table=daily --dry-run
wp top10 db prune --log-days=7 --table=log --force
wp top10 db prune --network

Line: 413

public function prune( array $args, array $assoc_args ): void;

Returns: void

aggregate()

Force-drain the visits funnel into the log and count tables.

OPTIONS

[–batch-size=] : Max funnel rows to process per run. Default: 10000.

[–dry-run] : Show how many funnel rows would be aggregated without processing them.

[–network] : Run aggregation for all sites in the network.

[–blog-id=] : Specific blog ID to aggregate (multisite only).

EXAMPLES

wp top10 db aggregate
wp top10 db aggregate --batch-size=5000
wp top10 db aggregate --dry-run

Line: 533

public function aggregate( array $args, array $assoc_args ): void;

Returns: void

truncate()

Truncate one or more Top 10 tables.

OPTIONS

[–table=

[–force] : Skip interactive confirmation.

[–dry-run] : Show what would be truncated without making changes.

[–network] : Truncate tables for all sites in the network.

[–blog-id=] : Specific blog ID to truncate tables for (multisite only).

EXAMPLES

wp top10 db truncate --table=funnel --force
wp top10 db truncate --table=all --dry-run
wp top10 db truncate --network --force

Line: 593

public function truncate( array $args, array $assoc_args ): void;

Returns: void

cleanup_orphans()

Remove count rows for posts that no longer exist.

OPTIONS

[–table=

[–batch-size=] : Rows to delete per iteration. Default: 1000.

[–force] : Skip interactive confirmation.

[–dry-run] : Count orphan rows without deleting.

[–network] : Run for all sites in the network.

[–blog-id=] : Specific blog ID (multisite only).

EXAMPLES

wp top10 db cleanup-orphans --dry-run
wp top10 db cleanup-orphans --table=overall --force

Line: 675

public function cleanup_orphans( array $args, array $assoc_args ): void;

Returns: void