Module: SQLite3::Constants::Status

Defined in:

lib/sqlite3/constants.rb

Overview

CAPI3REF: Status Parameters

These integer constants designate various run-time status parameters that can be returned by SQLite3.status

Constant Summary

MEMORY_USED =

This parameter is the current amount of memory checked out using sqlite3_malloc(), either directly or indirectly. The figure includes calls made to sqlite3_malloc() by the application and internal memory usage by the SQLite library. Auxiliary page-cache memory controlled by SQLITE_CONFIG_PAGECACHE is not included in this parameter. The amount returned is the sum of the allocation sizes as reported by the xSize method in sqlite3_mem_methods.

0

PAGECACHE_USED =

This parameter returns the number of pages used out of the pagecache memory allocator that was configured using SQLITE_CONFIG_PAGECACHE. The value returned is in pages, not in bytes.

1

PAGECACHE_OVERFLOW =

This parameter returns the number of bytes of page cache allocation which could not be satisfied by the SQLITE_CONFIG_PAGECACHE buffer and where forced to overflow to sqlite3_malloc(). The returned value includes allocations that overflowed because they where too large (they were larger than the “sz” parameter to SQLITE_CONFIG_PAGECACHE) and allocations that overflowed because no space was left in the page cache.

2

SCRATCH_USED =

NOT USED

3

SCRATCH_OVERFLOW =

NOT USED

4

MALLOC_SIZE =

This parameter records the largest memory allocation request handed to sqlite3_malloc() or sqlite3_realloc() (or their internal equivalents). Only the value returned in the *pHighwater parameter to sqlite3_status() is of interest. The value written into the *pCurrent parameter is undefined.

5

PARSER_STACK =

The *pHighwater parameter records the deepest parser stack. The *pCurrent value is undefined. The *pHighwater value is only meaningful if SQLite is compiled with YYTRACKMAXSTACKDEPTH.

6

PAGECACHE_SIZE =

This parameter records the largest memory allocation request handed to the pagecache memory allocator. Only the value returned in the *pHighwater parameter to sqlite3_status() is of interest. The value written into the *pCurrent parameter is undefined.

7

SCRATCH_SIZE =

NOT USED

8

MALLOC_COUNT =

This parameter records the number of separate memory allocations currently checked out.

9