Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using sqlite3 as a notekeeping document graph with automatic reference indexing #966

Open
1 task
ShellLM opened this issue Jan 3, 2025 · 0 comments
Open
1 task
Labels
Notes My own notes Sqlite Sqlite DB and tools technical-writing Links to deep technical writing and books

Comments

@ShellLM
Copy link
Collaborator

ShellLM commented Jan 3, 2025

Using SQLite3 as a Notekeeping Document Graph with Automatic Reference Indexing

Overview

A comprehensive approach to managing notes and references using SQLite3, featuring:

  • Portable note storage
  • Full-text search
  • Automatic reference indexing
  • Flexible document management

Key Features

Pros

  • Notes stored in a single, portable file
  • Support for various plain text formats
  • CLI and editor-friendly workflow
  • Automatic reference link calculations
  • Full-text search capabilities
  • Note collections and tagging
  • File attachment support

Cons

  • Potential database corruption risk
  • Requires SQL and command-line knowledge
  • Potential reference management challenges

Key Technical Concepts

Database Schema

  • Uses UUIDs for primary keys
  • Supports metadata and file attachments
  • Leverages SQLite's JSON1 extension
  • Full-text search with FTS5
  • Reference indexing mechanism

Reference Indexing

  • UUID recognition in text
  • Cross-reference tracking
  • Supports bidirectional references

Demonstration Examples

Includes SQL examples for:

  • Creating tables
  • Inserting notes
  • Searching notes
  • Managing references
  • Handling file attachments

Project Links

License

GPLv3

Suggested labels

None

@ShellLM ShellLM added Notes My own notes Sqlite Sqlite DB and tools technical-writing Links to deep technical writing and books labels Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Notes My own notes Sqlite Sqlite DB and tools technical-writing Links to deep technical writing and books
Projects
None yet
Development

No branches or pull requests

1 participant