Skip to contents

List items from the local database

zotLocalItems.Rd

Returns key, library, type, title, and dates for non-trashed items as a data.table. See zotLocalQuery() for synchronization and read-only details.

Usage

zotLocalItems(
  library = NULL,
  path = file.path(Sys.getenv("HOME"), "Zotero", "zotero.sqlite")
)

Arguments

library

NULL for every library, "user" for the personal library, or a numeric group id.

path

Database file.

Value

A data.table with key, groupID (0 for personal), itemType, title, dateAdded and dateModified.

See also

zotLocalQuery(), ztCensus(), and ztSemantic().

Examples

# A temporary database with the tables used by zotLocalItems().
Path <- tempfile(fileext = ".sqlite")
Connection <- DBI::dbConnect(RSQLite::SQLite(), Path)
DBI::dbWriteTable(Connection, "libraries", data.frame(libraryID = 1:2))
DBI::dbWriteTable(Connection, "groups",
                  data.frame(libraryID = 2L, groupID = 555L))
DBI::dbWriteTable(Connection, "itemTypes",
                  data.frame(itemTypeID = 1L, typeName = "journalArticle"))
DBI::dbWriteTable(Connection, "items", data.frame(
  itemID = 1:3, key = c("AAA", "BBB", "CCC"), libraryID = c(1L, 2L, 1L),
  itemTypeID = 1L, dateAdded = "2026-01-01", dateModified = "2026-01-01"
))
DBI::dbWriteTable(Connection, "fieldsCombined",
                  data.frame(fieldID = 110L, fieldName = "title"))
DBI::dbWriteTable(Connection, "itemData",
                  data.frame(itemID = 1:3, fieldID = 110L, valueID = 1:3))
DBI::dbWriteTable(Connection, "itemDataValues", data.frame(
  valueID = 1:3, value = c("Personal article", "Group article", "Trashed article")
))
DBI::dbWriteTable(Connection, "deletedItems", data.frame(itemID = 3L))
DBI::dbDisconnect(Connection)

zotLocalItems(library = "user", path = Path)
#>       key groupID       itemType            title  dateAdded dateModified
#>    <char>   <int>         <char>           <char>     <char>       <char>
#> 1:    AAA       0 journalArticle Personal article 2026-01-01   2026-01-01
zotLocalItems(library = 555, path = Path)
#>       key groupID       itemType         title  dateAdded dateModified
#>    <char>   <int>         <char>        <char>     <char>       <char>
#> 1:    BBB     555 journalArticle Group article 2026-01-01   2026-01-01
unlink(Path)