Skip to content

README.md

Latest commit

 

History

History
60 lines (45 loc) · 1.72 KB

README.md

File metadata and controls

60 lines (45 loc) · 1.72 KB
Raw

kdbx-modules

Repository for Data Intellect KDB-X modules.

See discussions tab for proposed modules and issues tab for modules in active development.

Usage

In order to use the modules from this repo:

  1. Download the modules code here
$ wget https://github.com/DataIntellectTech/kdbx-modules/archive/refs/heads/main.zip
  1. Unzip downloaded code
$ unzip main.zip
  1. Set QPATH environment variable to point to download location (preserving any existing value)
$ export QPATH=${QPATH}:~/kdbx-modules-main/
  1. Run KDB-X and use use keyword to import modules - all modules begin with di. e.g. di.querylog
$ q
KDB-X 0.1.2 2025.10.18 Copyright (C) 1993-2025 Kx Systems

q)querylog:use`di.querylog

Module layout

Each module consists of:

  • code
  • documentation
  • tests

Tests are run using k4unit (which is also a module). To run the tests for a module:

q)k4unit:use`di.k4unit
q)k4unit.moduletest`module_to_test

Contributing

We enthusiastically welcome contributions from outside of Data Intellect. If you would like to contribute code, please do so via Pull Request. We also welcome comments on open Pull Requests reviewing code.

Please create a separate directory for each module and place code, documentation and unit tests within. All modules must have documentation and unit tests to be accepted.

Style should conform to the style guide in this repository, and implement the outlined consistency requirements.