Is there any documents for introducing WHMCS database tables?

[mark_leo]

I check the WHMCS's table, there have so many table of it.

 

```

mysql> show tables;

+-------------------------------------+

| Tables_in_whmcs                     |

+-------------------------------------+

| deploymentcode_licenses             |

| mod_custom_ipmi                     |

| mod_dedicated_install               |

| mod_enomnewtlds                     |

| mod_enomnewtlds_cron                |

| mod_invoicedata                     |

| mod_onlinenic                       |

| mod_project                         |

| mod_project_management_files        |

| mod_projectlog                      |

| mod_projectmessages                 |

| mod_projecttasks                    |

| mod_projecttasktpls                 |

| mod_projecttimes                    |

| mod_renewal                         |

| mod_staffboard                      |

| nocpsforwhmcs_acl_groups            |

| nocpsforwhmcs_activitylog           |

| nocpsforwhmcs_automatedInstallation |

| nocpsforwhmcs_cl_OS                 |

| nocpsforwhmcs_ipmanager_ips         |

| nocpsforwhmcs_ipmanager_ipv6        |

| nocpsforwhmcs_ipmanager_poolconfig  |

| nocpsforwhmcs_isos                  |

| nocpsforwhmcs_override_acl          |

| nocpsforwhmcs_servers               |

| nocpsforwhmcs_settings              |

| tblaccounts                         |

| tblactivitylog                      |

| tbladdonmodules                     |

| tbladdons                           |

| tbladminlog                         |

| tbladminperms                       |

| tbladminroles                       |

| tbladmins                           |

| tbladminsecurityquestions           |

| tblaffiliates                       |

| tblaffiliatesaccounts               |

| tblaffiliateshistory                |

| tblaffiliatespending                |

| tblaffiliateswithdrawals            |

| tblannouncements                    |

| tblapi_roles                        |

| tblapilog                           |

| tblapplinks                         |

| tblapplinks_links                   |

| tblapplinks_log                     |

| tblauthn_account_links              |

| tblauthn_config                     |

| tblbannedemails                     |

| tblbannedips                        |

| tblbillableitems                    |

| tblbundles                          |

| tblcalendar                         |

| tblcancelrequests                   |

| tblclientgroups                     |

| tblclients                          |

| tblclientsfiles                     |

| tblconfiguration                    |

| tblcontacts                         |

| tblcredit                           |

| tblcurrencies                       |

| tblcustomfields                     |

| tblcustomfieldsvalues               |

| tbldeviceauth                       |

| tbldomain_lookup_configuration      |

| tbldomainpricing                    |

| tbldomainpricing_premium            |

| tbldomainreminders                  |

| tbldomains                          |

| tbldomains_extra                    |

| tbldomainsadditionalfields          |

| tbldownloadcats                     |

| tbldownloads                        |

| tbldynamic_translations             |

| tblemailmarketer                    |

| tblemails                           |

| tblemailtemplates                   |

| tblfraud                            |

| tblgatewaylog                       |

| tblhosting                          |

| tblhostingaddons                    |

| tblhostingconfigoptions             |

| tblinvoiceitems                     |

| tblinvoices                         |

| tbljobs_queue                       |

| tblknowledgebase                    |

| tblknowledgebasecats                |

| tblknowledgebaselinks               |

| tblknowledgebasetags                |

| tbllinks                            |

| tbllog_register                     |

| tblmarketconnect_services           |

| tblmodule_configuration             |

| tblmodulelog                        |

| tblmodulequeue                      |

| tblnetworkissues                    |

| tblnotes                            |

| tblnotificationproviders            |

| tblnotificationrules                |

| tbloauthserver_access_token_scopes  |

| tbloauthserver_access_tokens        |

| tbloauthserver_auth_codes           |

| tbloauthserver_authcode_scopes      |

| tbloauthserver_client_scopes        |

| tbloauthserver_clients              |

| tbloauthserver_scopes               |

| tbloauthserver_user_authz           |

| tbloauthserver_user_authz_scopes    |

| tblorders                           |

| tblorderstatuses                    |

| tblpaymentgateways                  |

| tblpricing                          |

| tblproduct_downloads                |

| tblproduct_group_features           |

| tblproduct_upgrade_products         |

| tblproductconfiggroups              |

| tblproductconfiglinks               |

| tblproductconfigoptions             |

| tblproductconfigoptionssub          |

| tblproductgroups                    |

| tblproducts                         |

| tblpromotions                       |

| tblquoteitems                       |

| tblquotes                           |

| tblregistrars                       |

| tblrsakeypairs                      |

| tblservergroups                     |

| tblservergroupsrel                  |

| tblservers                          |

| tblserversssoperms                  |

| tblsslorders                        |

| tbltask                             |

| tbltask_status                      |

| tbltax                              |

| tblticket_watchers                  |

| tblticketbreaklines                 |

| tblticketdepartments                |

| tblticketescalations                |

| tblticketfeedback                   |

| tblticketlog                        |

| tblticketmaillog                    |

| tblticketnotes                      |

| tblticketpredefinedcats             |

| tblticketpredefinedreplies          |

| tblticketreplies                    |

| tbltickets                          |

| tblticketspamfilters                |

| tblticketstatuses                   |

| tbltickettags                       |

| tbltld_categories                   |

| tbltld_category_pivot               |

| tbltlds                             |

| tbltodolist                         |

| tbltransientdata                    |

| tblupdatehistory                    |

| tblupdatelog                        |

| tblupgrades                         |

| tblwhoislog                         |

+-------------------------------------+

```

 

I glance over the document of WHMCS, do not find any document introduce the database tables. 

So, is there any documents for introducing the database tables?

[Grizzlyware Josh]

Not exactly documentation to the tables, as a lot of the models extend the WHMCS ones which define the tables, but you can see a fair number of the models here: https://github.com/grizzlyware/salmon-whmcs/tree/master/src/Grizzlyware/Salmon/WHMCS

[brian!]

22 hours ago, mark_leo said:

I glance over the document of WHMCS, do not find any document introduce the database tables.  

So, is there any documents for introducing the database tables? 

https://developers.whmcs.com/advanced/db-interaction/

Quote

Use the Capsule::schema() method to access the schema manager to modify table schema if necessary. The schema manager has support for creating, dropping and truncating tables and for modifying columns, indexes, and keys.

Note: WHMCS does not recommend changing default table schema as that can affect product functionality.

<?php

use WHMCS\Database\Capsule;

// Create a new table.
try {
    Capsule::schema()->create(
        'my_table',
        function ($table) {
            /** @var \Illuminate\Database\Schema\Blueprint $table */
            $table->increments('id');
            $table->string('name');
            $table->integer('serial_number');
            $table->boolean('is_required');
            $table->timestamps();
        }
    );
} catch (\Exception $e) {
    echo "Unable to create my_table: {$e->getMessage()}";
}