Documentation
¶
Index ¶
- Variables
- type Database
- func (d *Database) Close() error
- func (d *Database) CreateBook(b *quicknote.Book) error
- func (d *Database) CreateNote(n *quicknote.Note) error
- func (d *Database) CreateTag(t *quicknote.Tag) error
- func (d *Database) DeleteBook(bk *quicknote.Book) error
- func (d *Database) DeleteNote(n *quicknote.Note) error
- func (d *Database) EditBook(b *quicknote.Book) error
- func (d *Database) EditNote(n *quicknote.Note) error
- func (d *Database) EditNoteByIDBook(ids []int64, bk *quicknote.Book) error
- func (d *Database) GetAllBookNotes(book *quicknote.Book, sortBy, order string) (quicknote.Notes, error)
- func (d *Database) GetAllBookTags(bk *quicknote.Book) (quicknote.Tags, error)
- func (d *Database) GetAllBooks() (quicknote.Books, error)
- func (d *Database) GetAllNotes(sortBy, order string) (quicknote.Notes, error)
- func (d *Database) GetAllTags() (quicknote.Tags, error)
- func (d *Database) GetBookByName(name string) (*quicknote.Book, error)
- func (d *Database) GetNoteByID(id int64) (*quicknote.Note, error)
- func (d *Database) GetNoteByNote(n *quicknote.Note) error
- func (d *Database) GetNotesByIDs(ids []int64) (quicknote.Notes, error)
- func (d *Database) GetOrCreateBookByName(name string) (*quicknote.Book, error)
- func (d *Database) GetOrCreateTagByName(name string) (*quicknote.Tag, error)
- func (d *Database) GetTableNames() ([]string, error)
- func (d *Database) GetTagByName(name string) (*quicknote.Tag, error)
- func (d *Database) GetTagsByName(name string) (*quicknote.Tag, error)
- func (d *Database) LoadBook(b *quicknote.Book) error
- func (d *Database) LoadNoteTags(n *quicknote.Note) error
- func (d *Database) MergeBooks(b1 *quicknote.Book, b2 *quicknote.Book) error
- func (d *Database) ResetTables() error
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidArguments = errors.New("Invalid arguments given to PostgreSQL database")
ErrInvalidArguments invalid arguments were given
Functions ¶
This section is empty.
Types ¶
type Database ¶
type Database struct {
// contains filtered or unexported fields
}
Database provides an interface to PostgreSQL
func NewDatabase ¶
NewDatabase returns a data Database
func (*Database) CreateBook ¶
CreateBook saves the Book to the database
func (*Database) CreateNote ¶
CreateNote saves the note to the database
func (*Database) DeleteBook ¶
DeleteBook deletes the Book from the database
func (*Database) DeleteNote ¶
DeleteNote delete note from database
func (*Database) EditNoteByIDBook ¶
EditNoteByIDBook updates all notes for the given IDs with the Book bk's ID
func (*Database) GetAllBookNotes ¶
func (d *Database) GetAllBookNotes(book *quicknote.Book, sortBy, order string) (quicknote.Notes, error)
GetAllBookNotes returns all notes for the given Notebook
func (*Database) GetAllBookTags ¶
GetAllBookTags returns all tags for the given Book
func (*Database) GetAllBooks ¶
GetAllBooks returns all Books
func (*Database) GetAllNotes ¶
GetAllNotes returns all notes
func (*Database) GetAllTags ¶
GetAllTags returns all tags
func (*Database) GetBookByName ¶
GetBookByName returns the Book for the given name
func (*Database) GetNoteByID ¶
GetNoteByID returns the note for the given ID
func (*Database) GetNoteByNote ¶
GetNoteByNote Loads the note's ID, Created, and Modified fields
func (*Database) GetNotesByIDs ¶
GetNotesByIDs returns all notes for the given Notebook
func (*Database) GetOrCreateBookByName ¶
GetOrCreateBookByName gets the Book by name creating it if it does not exists
func (*Database) GetOrCreateTagByName ¶
GetOrCreateTagByName returns a tag, creating it if it does not exists
func (*Database) GetTableNames ¶
GetTableNames returns a list of all table names
func (*Database) GetTagByName ¶
GetTagByName returns the tag with the given name
func (*Database) GetTagsByName ¶
GetTagsByName returns the Tag for the given name
func (*Database) LoadNoteTags ¶
LoadNoteTags loads all the tags for the given Note
func (*Database) MergeBooks ¶
MergeBooks merge all notes from Book b1 into Book b2