Database

---

Object Hierarchy:

Description:

Content:

Properties:

• public int wal_auto_checkpoint { set; get; }
  Write-ahead logging auto checkpoint interval
• public Database database { owned get; }
  Database
• public ProfilingDatabase? profiling_data { set; get; }
  Database to store profiling data in.
• public bool enable_profiling { set; get; }
  Whether profiling is enabled.
• public string filename { construct; get; }
  The location of the database
• public FileMode mode { construct; get; }
  The mode used when opening the database.
• public int64 last_insert_id { get; }
  The last inserted row ID
• public int lookaside_used { get; }
  Number of lookaside memory slots currently checked out
• public AutoVacuum auto_vacuum { set; get; }
  Auto-Vacuum mode
• public int cache_size { set; get; }
  Cache size
• public bool case_sensitive_like { set; get; }
  Case-sensitive like
• public bool count_changes { set; get; }
  Count changes
• public int default_cache_size { set; get; }
  Default cache size
• public bool empty_result_callbacks { set; get; }
  Empty result callbacks
• public Encoding encoding { set; get; }
  Encoding
• public bool foreign_keys { set; get; }
  Foreign keys
• public bool full_column_names { set; get; }
  Full column names
• public bool full_fsync { set; get; }
  Full fsync
• public JournalMode journal_mode { set; get; }
  Journal mode
• public int journal_size_limit { set; get; }
  Journal size limit
• public bool legacy_file_format { set; get; }
  Legacy file format
• public LockingMode locking_mode { set; get; }
  Locking mode
• public int page_size { set; get; }
  Page size
• public int max_page_count { set; get; }
  Max page count
• public bool read_uncommitted { set; get; }
  Read uncommitted
• public bool recursive_triggers { set; get; }
  Recursive triggers
• public bool reverse_unordered_selects { set; get; }
  Reverse unordered selects
• public bool short_column_names { set; get; }
  Short column names
• public SynchronousMode synchronous { set; get; }
  Synchronous mode
• public TempStoreMode temp_store { set; get; }
  Temporary store mode
• public string temp_store_directory { set; owned get; }
  Temporary store directory
• public int free_list_count { get; }
  Free list count
• public int page_count { set; get; }
  Page count
• public int schema_version { set; get; }
  Schema version
• public bool secure_delete { set; get; }
  Secure-delete
• public int user_version { set; get; }
  User version
• public bool parser_trace { set; get; }
  Parser trace
• public bool vdbe_trace { set; get; }
  VDBE trace
• public bool vdbe_listing { set; get; }
  VDBE listing

Static methods:

• public static int compare (Database? a, Database? b)
  Compare two databases

Creation methods:

• public Database (string? filename =null, FileMode mode = READ | WRITE | CREATE) throws Error
  Open a database.

Methods:

• public void lock ()
  Lock the queryable and refuse to run any queries against it.
• public void unlock ()
  Unlock the queryable and allow queries to be run against it.
• public void queue (Query query) throws Error
  Queue a query to be executed when the queryable is unlocked
• public void interrupt ()
  Interrupt (cancel) the currently running query
• public void incremental_vacuum (int pages) throws Error
  Incremental vacuum
• public void register_aggregate_function (string name, int argc, owned UserFunc func, owned FinalizeFunc final)
  Register aggregate function for use within SQLite
• public void register_scalar_function (string name, int argc, owned UserFunc func)
  Register a scalar function for use within SQLite
• public void unregister_function (string name)
  Unregister a function
• public void register_common_functions ()
  Registers common functions
• public void backup (string destination) throws Error
  Backup database
• public async void backup_async (string destination) throws Error
  Backup database asynchronously
• public void wal_checkpoint (string? database =null) throws Error
  Checkpoint the specified database
• public Table get_table (string table) throws Error
  Return a reference to the requested table
• public HashTable<string,Table> get_tables () throws Error
  List all tables in the database
• public virtual bool init (Cancellable? cancellable =null) throws Error
  Initialize the database

Signals:

• public virtual void wal_committed (string db_name, int pages)
  Emitted when data is committed to the write-ahead log
• public void sql_executed (string sql)
  SQL executed