Skip to content

Docs: Draft VIDEX plugin + VIDEX-Server guide#303

Merged
mariadb-stefan-hinz merged 1 commit intomariadb-corporation:mainfrom
kr11:videx-documentation
Jan 26, 2026
Merged

Docs: Draft VIDEX plugin + VIDEX-Server guide#303
mariadb-stefan-hinz merged 1 commit intomariadb-corporation:mainfrom
kr11:videx-documentation

Conversation

@kr11
Copy link
Copy Markdown
Contributor

@kr11 kr11 commented Jan 19, 2026

This PR adds an initial draft documentation page for the VIDEX storage engine.

  • New doc: server/server-usage/storage-engines/videx/videx-storage-engine.md
  • Describes what VIDEX is and how to get started:
    • install/enable the VIDEX plugin
    • run VIDEX-Server
    • run a one-shot videx-sync workflow to build a VIDEX schema
    • compare EXPLAIN between the original schema and the VIDEX schema
  • Provides a Docker-based workflow so users can complete the end-to-end flow with a few concise commands (launch videx-server + run videx-sync).

Related:

@kr11
Copy link
Copy Markdown
Contributor Author

kr11 commented Jan 19, 2026

Hi @grooverdan @vuvova, we’ve added the initial version of the VIDEX documentation to address https://jira.mariadb.org/browse/MDEV-38409. Could you please review it?

Comment thread server/server-usage/storage-engines/videx/videx-storage-engine.md
- A running MariaDB server you can connect to (the “target”).
- A MariaDB build that includes the `VIDEX` engine plugin (the “MariaDB-VIDEX”).
- For a quick start, the target MariaDB and MariaDB-VIDEX can be the same instance.
- Docker (to run VIDEX-Server and videx-sync).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docker -> A container runtime

Comment thread server/server-usage/storage-engines/videx/videx-storage-engine.md
@mariadb-stefan-hinz mariadb-stefan-hinz merged commit 806bb55 into mariadb-corporation:main Jan 26, 2026
1 of 2 checks passed
mariadb-stefan-hinz added a commit that referenced this pull request Jan 26, 2026
…nly one file. Add VIDEX to SUMMARY.md so that it shows up online.
@mariadb-stefan-hinz
Copy link
Copy Markdown
Contributor

mariadb-stefan-hinz commented Feb 1, 2026 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants