Inheritance diagram for searx.sqlitedb.SQLiteProperties:

Collaboration diagram for searx.sqlitedb.SQLiteProperties:

Public Member Functions
	__init__ (self, str db_url)

	init (self)

	__call__ (self, name, default=None)

	set (self, name, value)

	row (self, name, default=None)

int	m_time (self, name, int default=0)

	create_schema (self, conn)

Public Member Functions inherited from searx.sqlitedb.SQLiteAppl
sqlite3.Connection	connect (self)

	register_functions (self, conn)

sqlite3.Connection	DB (self)

Public Attributes
	db_url = db_url

	thread_local = threading.local()

Public Attributes inherited from searx.sqlitedb.SQLiteAppl
	db_url = db_url

	properties = SQLiteProperties(db_url)

	thread_local = threading.local()

Static Public Attributes
str	SQLITE_JOURNAL_MODE = "WAL"

str	DDL_PROPERTIES

str	SQL_GET = "SELECT value FROM properties WHERE name = ?"

str	SQL_M_TIME = "SELECT m_time FROM properties WHERE name = ?"

tuple	SQL_SET

tuple	SQL_TABLE_EXISTS

	SQLITE_CONNECT_ARGS = dict(SQLiteAppl.SQLITE_CONNECT_ARGS)

Static Public Attributes inherited from searx.sqlitedb.SQLiteAppl
dict	DDL_CREATE_TABLES = {}

int	DB_SCHEMA = 1

dict	SQLITE_THREADING_MODE

str	SQLITE_JOURNAL_MODE = "WAL"

dict	SQLITE_CONNECT_ARGS

Protected Attributes
bool	_init_done = False

Protected Attributes inherited from searx.sqlitedb.SQLiteAppl
bool	_init_done = False

	_DB = None

Additional Inherited Members
Protected Member Functions inherited from searx.sqlitedb.SQLiteAppl
	_compatibility (self)

Detailed Description

Simple class to manage properties of a DB application in the DB.  The
object has its own DB connection and transaction area.

.. code:: sql

   CREATE TABLE IF NOT EXISTS properties (
     name       TEXT,
     value      TEXT,
     m_time     INTEGER DEFAULT (strftime('%s', 'now')),
     PRIMARY KEY (name))

Definition at line 224 of file sqlitedb.py.

Constructor & Destructor Documentation

◆ init()

searx.sqlitedb.SQLiteProperties.__init__	(		self,
		str	db_url )

Reimplemented from searx.sqlitedb.SQLiteAppl.

Definition at line 263 of file sqlitedb.py.

    def __init__(self, db_url: str):  # pylint: disable=super-init-not-called
 
        self.db_url = db_url
        self.thread_local = threading.local()
        self._init_done = False
        self._compatibility()
 

Member Function Documentation

◆ call()

searx.sqlitedb.SQLiteProperties.__call__	(	self,
		name,
		default = None )

Returns the value of the property ``name`` or ``default`` if property
not exists in DB.

Definition at line 282 of file sqlitedb.py.

    def __call__(self, name, default=None):
        """Returns the value of the property ``name`` or ``default`` if property
        not exists in DB."""
 
        res = self.DB.execute(self.SQL_GET, (name,)).fetchone()
        if res is None:
            return default
        return res[0]
 

References searx.sqlitedb.SQLiteAppl.DB(), and searx.sqlitedb.SQLiteProperties.SQL_GET.

Here is the call graph for this function:

◆ create_schema()

searx.sqlitedb.SQLiteProperties.create_schema	(		self,
			conn )

Reimplemented from searx.sqlitedb.SQLiteAppl.

Definition at line 321 of file sqlitedb.py.

    def create_schema(self, conn):
        with conn:
            conn.execute(self.DDL_PROPERTIES)

References searx.sqlitedb.SQLiteProperties.DDL_PROPERTIES.

Referenced by searx.sqlitedb.SQLiteAppl.init(), and searx.sqlitedb.SQLiteProperties.init().

Here is the caller graph for this function:

◆ init()

searx.sqlitedb.SQLiteProperties.init ( self )

Initializes DB schema of the properties in the DB.

Reimplemented from searx.sqlitedb.SQLiteAppl.

Definition at line 270 of file sqlitedb.py.

    def init(self):
        """Initializes DB schema of the properties in the DB."""
 
        if self._init_done:
            return
        self._init_done = True
        logger.debug("init properties of DB: %s", self.db_url)
        with self.DB as conn:
            res = conn.execute(self.SQL_TABLE_EXISTS)
            if res.fetchone() is None:  # DB schema needs to be be created
                self.create_schema(conn)
 

References searx.sqlitedb.SQLiteAppl._init_done, searx.sqlitedb.SQLiteProperties._init_done, searx.sqlitedb.SQLiteAppl.create_schema(), searx.sqlitedb.SQLiteProperties.create_schema(), searx.sqlitedb.SQLiteAppl.DB(), searx.favicons.cache.FaviconCacheConfig.db_url, searx.sqlitedb.SQLiteAppl.db_url, searx.sqlitedb.SQLiteProperties.db_url, and searx.sqlitedb.SQLiteProperties.SQL_TABLE_EXISTS.

Referenced by searx.sqlitedb.SQLiteAppl.connect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ m_time()

int searx.sqlitedb.SQLiteProperties.m_time	(		self,
			name,
		int	default = 0 )

Last modification time of this property.

Definition at line 314 of file sqlitedb.py.

    def m_time(self, name, default: int = 0) -> int:
        """Last modification time of this property."""
        res = self.DB.execute(self.SQL_M_TIME, (name,)).fetchone()
        if res is None:
            return default
        return int(res[0])
 

References searx.sqlitedb.SQLiteAppl.DB(), and searx.sqlitedb.SQLiteProperties.SQL_M_TIME.

Here is the call graph for this function:

◆ row()

searx.sqlitedb.SQLiteProperties.row	(	self,
		name,
		default = None )

Returns the DB row of property ``name`` or ``default`` if property
not exists in DB.

Definition at line 302 of file sqlitedb.py.

    def row(self, name, default=None):
        """Returns the DB row of property ``name`` or ``default`` if property
        not exists in DB."""
 
        cur = self.DB.cursor()
        cur.execute("SELECT * FROM properties WHERE name = ?", (name,))
        res = cur.fetchone()
        if res is None:
            return default
        col_names = [column[0] for column in cur.description]
        return dict(zip(col_names, res))
 

References searx.sqlitedb.SQLiteAppl.DB().

Here is the call graph for this function:

◆ set()

searx.sqlitedb.SQLiteProperties.set	(	self,
		name,
		value )

Set ``value`` of property ``name`` in DB.  If property already
exists, update the ``m_time`` (and the value).

Definition at line 291 of file sqlitedb.py.

    def set(self, name, value):
        """Set ``value`` of property ``name`` in DB.  If property already
        exists, update the ``m_time`` (and the value)."""
 
        self.DB.execute(self.SQL_SET, (name, value))
 
        if sys.version_info <= (3, 12):
            # Prior Python 3.12 there is no "autocommit" option / lets commit
            # explicitely.
            self.DB.commit()
 

References searx.sqlitedb.SQLiteAppl.DB(), and searx.sqlitedb.SQLiteProperties.SQL_SET.

Here is the call graph for this function:

Member Data Documentation

◆ _init_done

bool searx.sqlitedb.SQLiteProperties._init_done = False

protected

Definition at line 267 of file sqlitedb.py.

Referenced by searx.sqlitedb.SQLiteAppl.init(), and searx.sqlitedb.SQLiteProperties.init().

◆ db_url

searx.sqlitedb.SQLiteProperties.db_url = db_url

Definition at line 265 of file sqlitedb.py.

Referenced by searx.sqlitedb.SQLiteAppl.connect(), searx.sqlitedb.SQLiteAppl.init(), and searx.sqlitedb.SQLiteProperties.init().

◆ DDL_PROPERTIES

searx.sqlitedb.SQLiteProperties.DDL_PROPERTIES

static

Initial value:

=  """\
CREATE TABLE IF NOT EXISTS properties (
  name       TEXT,
  value      TEXT,
  m_time     INTEGER DEFAULT (strftime('%s', 'now')),  -- last modified (unix epoch) time in sec.
  PRIMARY KEY (name))"""

Definition at line 240 of file sqlitedb.py.

Referenced by searx.sqlitedb.SQLiteProperties.create_schema().

◆ SQL_GET

str searx.sqlitedb.SQLiteProperties.SQL_GET = "SELECT value FROM properties WHERE name = ?"

static

Definition at line 249 of file sqlitedb.py.

Referenced by searx.sqlitedb.SQLiteProperties.__call__().

◆ SQL_M_TIME

str searx.sqlitedb.SQLiteProperties.SQL_M_TIME = "SELECT m_time FROM properties WHERE name = ?"

static

Definition at line 250 of file sqlitedb.py.

Referenced by searx.sqlitedb.SQLiteProperties.m_time().

◆ SQL_SET

searx.sqlitedb.SQLiteProperties.SQL_SET

static

Initial value:

=  (
        "INSERT INTO properties (name, value) VALUES (?, ?)"
        "    ON CONFLICT(name) DO UPDATE"
        "   SET value=excluded.value, m_time=strftime('%s', 'now')"
    )

Definition at line 251 of file sqlitedb.py.

Referenced by searx.sqlitedb.SQLiteProperties.set().

◆ SQL_TABLE_EXISTS

tuple searx.sqlitedb.SQLiteProperties.SQL_TABLE_EXISTS

static

Initial value:

=  (
        "SELECT name FROM sqlite_master"
        " WHERE type='table' AND name='properties'"
    )

Definition at line 256 of file sqlitedb.py.

Referenced by searx.sqlitedb.SQLiteProperties.init().

◆ SQLITE_CONNECT_ARGS

searx.sqlitedb.SQLiteProperties.SQLITE_CONNECT_ARGS = dict(SQLiteAppl.SQLITE_CONNECT_ARGS)

static

Definition at line 260 of file sqlitedb.py.

Referenced by searx.sqlitedb.SQLiteAppl.connect().

◆ SQLITE_JOURNAL_MODE

str searx.sqlitedb.SQLiteProperties.SQLITE_JOURNAL_MODE = "WAL"

static

Definition at line 238 of file sqlitedb.py.

◆ thread_local

searx.sqlitedb.SQLiteProperties.thread_local = threading.local()

Definition at line 266 of file sqlitedb.py.

Referenced by searx.sqlitedb.SQLiteAppl.DB().

The documentation for this class was generated from the following file:

/home/andrew/Documents/code/public/searxng/searx/sqlitedb.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __call__()

◆ create_schema()

◆ init()

◆ m_time()

◆ row()

◆ set()

Member Data Documentation

◆ _init_done

◆ db_url

◆ DDL_PROPERTIES

◆ SQL_GET

◆ SQL_M_TIME

◆ SQL_SET

◆ SQL_TABLE_EXISTS

◆ SQLITE_CONNECT_ARGS

◆ SQLITE_JOURNAL_MODE

◆ thread_local

◆ init()

◆ call()