.. _ftotalrecords:

#####################################################################################
``total_records`` — Get the total number of a given type of record in the database.
#####################################################################################

:doc:`Db-related functions </Reference/packages/Function/Db/index>`

*******
Summary
*******

.. include:: /Reference/libraries/globals/summary/total_records.rst

.. php:function:: total_records($recordType)

    Get the total number of a given type of record in the database.
    
    :type $recordType: string
    :param $recordType: Type of record to count.
    :returns: int Number of records of $recordType in the database.

*****
Usage
*****

.. include:: /Reference/libraries/globals/usage/total_records.rst

********
Examples
********

.. include:: /Reference/libraries/globals/examples/total_records.rst

********
See Also
********

.. include:: /Reference/libraries/globals/see_also/total_records.rst