Database

NppSnippets uses a SQLite database named NppSnippets.sqlite to store all the content.

In the archive is a file named NppSnippets.sql. With this you can generate a new (almost empty) SQLite database. At least SQLite 3.6.19 is needed because a foreign key constrains are used and the plug-in will need this when editing the data through the GUI. So be sure not to create the database with an older SQLite management tool that breaks this.

You should only update, insert or delete records and not modify the structure of the database. That can cause the plug-in (and as a result of that Notepad++ itself) to crash.

The database structure is quite simple. There are four tables Library, LibraryLang, Snippets and LangLastUsed. There are one-to-many relations between Library and LibraryLang, between Library and Snippets and between Library and LangLastUsed. They are all linked to each other with the LibraryID field. It is possible to have multiple libraries per language and one library can be used for many languages. For every library at least one record in the LibraryLang and Snippets tables is needed.

The current schema user_version of the database is 3.

Why a SQLite database and not plain text files?

All the snippets are stored in one SQLite database. SQLite is fast and easy to use. With SQLite most of the file and storage handling is taken care of. This is much more efficient then designing my own (complex) file format and implementing a parser and a writer, although I understand that editing a SQLite database is not as easy to edit for some as editing plain text files. But there is a user interface for editing the snippets.

Table definitions

Library

Field Description
LibraryID The unique identifier of this library
Name Name of the library
CreatedBy Who created this library
Comments Comments about this library
SortBy Which fields of Snippets are used to sort: 0. “Name, Sort” 1. “Sort, Name”

LibraryLang

Field Description
LibraryID The library this item is part of
Lang

LangType from Notepad_plus_msgs.h. There are two special cases:

  • Libs with Lang = -1 are shown when there is no library for the current language
  • Libs with Lang = -2 are shown for every language

Snippets

Field Description
SnippetID The unique identifier of this snippet
LibraryID The library this item is part of
Name The name of the snippet
BeforeSelection The text inserted before the current cursor / selection
AfterSelection The text inserted after the current cursor / selection
ReplaceSelection Replace a selection or ignore the selection and insert
NewDocument Create a new document before inserting this snippet?
NewDocumentLang Change the language of the new document to this language
Sort Can determine the order of the snipping in the list. Depends on Library(SortBy) how the list is sorted.

LangLastUsed

Field Description
Lang LangType from Notepad_plus_msgs.h
LibraryID This library is the last one used for this language