Inheritance diagram for searx.sqlitedb.SQLiteProperties:

Collaboration diagram for searx.sqlitedb.SQLiteProperties:

Public Member Functions
	__init__ (self, str db_url)
bool	init (self, sqlite3.Connection conn)
t.Any	__call__ (self, str name, t.Any default=None)
	set (self, str name, str\|int value)
int	delete (self, str name)
	row (self, str name, t.Any default=None)
int	m_time (self, str name, int default=0)
	create_schema (self, sqlite3.Connection conn)
str	__str__ (self)
Public Member Functions inherited from searx.sqlitedb.SQLiteAppl
	__init__ (self, str db_url)
sqlite3.Connection	connect (self)
	register_functions (self, sqlite3.Connection conn)
sqlite3.Connection	DB (self)

Static Public Attributes
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
str	SQL_DELETE = "DELETE FROM properties WHERE name = ?"
tuple	SQL_TABLE_EXISTS
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

Additional Inherited Members
Public Attributes inherited from searx.sqlitedb.SQLiteAppl
str	db_url = db_url
SQLiteProperties	properties = SQLiteProperties(db_url)
Protected Member Functions inherited from searx.sqlitedb.SQLiteAppl
	_compatibility (self)
sqlite3.Connection	_connect (self)
Protected Attributes inherited from searx.sqlitedb.SQLiteAppl
bool	_init_done = False
sqlite3.Connection\|None	_DB = None

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 319 of file sqlitedb.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 359 of file sqlitedb.py.

    def __init__(self, db_url: str):  # pyright: ignore[reportMissingSuperCall]
 
        self.db_url: str = db_url
        self._init_done: bool = False
        self._compatibility()
 

Member Function Documentation

◆ call()

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

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

Definition at line 377 of file sqlitedb.py.

    def __call__(self, name: str, default: t.Any = None) -> t.Any:
        """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.cache.ExpireCacheSQLite.DB, DB, and SQL_GET.

◆ str()

str searx.sqlitedb.SQLiteProperties.__str__ ( self )

Definition at line 423 of file sqlitedb.py.

    def __str__(self) -> str:
        lines: list[str] = []
        for row in self.DB.execute("SELECT name, value, m_time FROM properties"):
            name, value, m_time = row
            m_time = datetime.datetime.fromtimestamp(m_time).strftime("%Y-%m-%d %H:%M:%S")
            lines.append(f"[last modified: {m_time}] {name:20s}: {value}")
        return "\n".join(lines)

References searx.cache.ExpireCacheSQLite.DB, and DB.

◆ create_schema()

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

Reimplemented from searx.sqlitedb.SQLiteAppl.

Definition at line 419 of file sqlitedb.py.

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

References DDL_PROPERTIES.

◆ delete()

int searx.sqlitedb.SQLiteProperties.delete	(		self,
		str	name )

Delete of property ``name`` from DB.

Definition at line 393 of file sqlitedb.py.

    def delete(self, name: str) -> int:
        """Delete of property ``name`` from DB."""
        with self.DB:
            cur = self.DB.execute(self.SQL_DELETE, (name,))
        return cur.rowcount
 

References searx.cache.ExpireCacheSQLite.DB, DB, and SQL_DELETE.

◆ init()

bool searx.sqlitedb.SQLiteProperties.init	(		self,
		sqlite3.Connection	conn )

Initializes DB schema of the properties in the DB.

Reimplemented from searx.sqlitedb.SQLiteAppl.

Definition at line 365 of file sqlitedb.py.

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

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

Here is the call graph for this function:

◆ m_time()

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

Last modification time of this property.

Definition at line 411 of file sqlitedb.py.

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

References searx.cache.ExpireCacheSQLite.DB, DB, and SQL_M_TIME.

◆ row()

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

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

Definition at line 399 of file sqlitedb.py.

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

References searx.cache.ExpireCacheSQLite.DB, and DB.

◆ set()

searx.sqlitedb.SQLiteProperties.set	(		self,
		str	name,
		str \| int	value )

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

Definition at line 386 of file sqlitedb.py.

    def set(self, name: str, value: str | int):
        """Set ``value`` of property ``name`` in DB.  If property already
        exists, update the ``m_time`` (and the value)."""
 
        with self.DB:
            self.DB.execute(self.SQL_SET, (name, value))
 

Member Data Documentation

◆ 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 335 of file sqlitedb.py.

Referenced by create_schema().

◆ SQL_DELETE

str searx.sqlitedb.SQLiteProperties.SQL_DELETE = "DELETE FROM properties WHERE name = ?"

static

Definition at line 351 of file sqlitedb.py.

Referenced by delete().

◆ SQL_GET

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

static

Definition at line 344 of file sqlitedb.py.

Referenced by __call__().

◆ SQL_M_TIME

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

static

Definition at line 345 of file sqlitedb.py.

Referenced by 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 346 of file sqlitedb.py.

◆ 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 352 of file sqlitedb.py.

Referenced by init().

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __call__()

◆ __str__()

◆ create_schema()

◆ delete()

◆ init()

◆ m_time()

◆ row()

◆ set()

Member Data Documentation

◆ DDL_PROPERTIES

◆ SQL_DELETE

◆ SQL_GET

◆ SQL_M_TIME

◆ SQL_SET

◆ SQL_TABLE_EXISTS

◆ init()

◆ call()

◆ str()