Web UI for inspecting XTDB database
Demo:
Browsing documents and showing history:
Query viewer and saved queries:
To simply try it out, start repl with :dev alias:
- eval
(start)in your REPL - eval
(some-docs)in your REPL to generate test docs - open http://localhost:3000/doc/%3Ahello in browser
Other way is to embed in an existing web application that
uses XTDB. The xtdb-inspector.core/inspector-handler returns
a ring handler. See monitoring below for config that needs to
be added to the XTDB node.
To enable the UI access to the XTDB monitoring, configure the monitoring reporter in the XTDB node config:
:xtdb-inspector.metrics/reporter {}
Sometime (e.g., when embedding xtdb-inspector in another web application) there is a need for having all of its URLs prefixed. Simply set the environment variable XTDB_INSPECTOR_URI_PREFIX:
- run
export XTDB_INSPECTOR_URI_PREFIX=/_inspectorin your shell - eval
(start)in your REPL - eval
(some-docs)in your REPL - open http://localhost:3000/_inspector/doc/%3Ahello in a browser.
- Support for
:inarguments in queries
- Format metrics numbers with NumberFormat
- Support custom URI prefix
- Fix nested pull problem in query page
- Support exporting query to EDN file
- Add
:allow-editing?configuration option (default:true) for disabling doc edit functionality - Support
:wrap-page-fnthat wraps any page rendering with a custom fn
- Show latest transaction first by default
- Dashboard page
- Graphs for attribute values
- Pretty print EDN values (better coloring and layout)
- Add new page for transaction log
- Document view can expand linked docs inline
- FIXED Attribute name in URL is encoded, so attributes with URL characters (like ?) work
- Add convenience button to document page to copy the doc id to clipboard
- Tables now have filtering and ordering
- Attribute values page limits to 100 items (with button to fetch more)
- Remember last run query in editor page
- Add
java.time.Instantdisplay and editing - Allow adding new attributes and creating documents
- Better display end edit non-EDN values (
java.timetypes)
- Add top bar navigation with search. Can query lucene index to find docs.
- Directly navigate to saved query by name (
/query/<query name>) to load it - New attribute page that shows attributes and their values
- Document page can now do simple edits to the values