You are here: start » en » Internal Documentation » DokuWiki extensions (WvdS) » SQLite Data Studio » Quickstart: first connection, first query

Quickstart: first connection, first query

The shortest way from “the plugin is installed” to “a named connection stands, and a query over it returns rows”. Four steps, about ten minutes.

Prerequisites

  • wksqliteds and wkcore are installed and enabled.
  • You are signed in as superuser.
  • The PDO driver for the database you want is present in PHP. For SQLite, pdo_sqlite is enough.
  • A database. For SQLite a file path suffices; the file need not exist yet.

Step 1: switch the query assistant on

Admin → Configuration, section wksqliteds:

enable_dbadmin = 1

Since 2026-08-25 the default is 1 — the area is normally already there, so this step is a check rather than a setup. If it is missing anyway, the instance switched it off: look in conf/local.protected.php, which loads after conf/local.php and therefore wins. A 1 in local.php alone says nothing.

While you are there, consider dbadmin_readonly. On, the assistant browses and queries but does not write — a reasonable standing state for an installation where the studio is for looking rather than changing.

Step 2: create the connection

Admin → SQLite Data Studio, directly /doku.php?do=admin&page=wksqliteds. Area Connections.

Add a connection. It gets a name — everything from here on refers to that; nothing addresses a database by path or host after this step.

  • SQLite: the file path is enough.
  • Server databases (MSSQL, MySQL, PostgreSQL, ODBC): host, database, user and password.

Then put the name into default_connection, so callers that name none have somewhere to go.

Step 3: test the connection

Choose Test connection.

The test separates three causes that otherwise arrive later as one unhelpful message: missing driver, rejected credentials, unreachable database.

Do not continue until the test succeeds.

Step 4: run the first query

Switch to the Query Assistant area, pick your connection under Connection, and enter a query — for a fresh SQLite file, say:

SELECT name, TYPE FROM sqlite_master ORDER BY name

Choose Run.

Check the result

  • The result grid shows the rows — for an empty new file none, but the column headers name and type are there. That is what proves the query ran and the connection carries.
  • The Object Explorer on the left lists the connection's objects.
  • Under Query history in the right rail the run appears with time and duration.
  • Counter-check on the ceiling: run a SELECT without WHERE over a large table. You get the first dbadmin_max_result_rows rows and a note that the result was capped. For real work with large results, page through them rather than raising the cap.
On this installation dbadmin_max_result_rows is 0. The value 0 removes the cap — the counter-check above therefore shows the full result set here. What that costs in HTML and processing time is on the package page.

Next step

  • wkblog — the blog engine runs on the named routines this package supplies.
  • Routines (German) — store the query as a named file pair (.sql plus manifest), with named parameters instead of interpolated values. The assistant offers Save as routine for that.
  • Permissions (German) — who may query, write, design and export.
en/wiki/dwe/wksqliteds/quickstart.txt · Last modified: by 0.0.0.0