idf_index_query: Query _docs_ from an iDAI.field Database Based on an Index...

View source: R/idf_query.R

idf_index_queryR Documentation

Query docs from an iDAI.field Database Based on an Index (uidlist)

Description

This function can be used to gather docs from an iDAI.field / Field Desktop Database according to the values of listed in an index as returned by get_field_index() or get_uid_list().

Usage

idf_index_query(
  connection,
  field = "category",
  value = "Brick",
  uidlist = NULL,
  projectname = NULL
)

Arguments

connection

A connection object as returned by connect_idaifield()

field

character. The resource field that should be selected for (options are limited to the column names of the uidlist).

value

character. The value to be selected for in the specified field.

uidlist

A data.frame as returned by get_field_index() (or get_uid_list()).

projectname

(deprecated) The name of the project to be queried (overrides the one listed in the connection-object).

Value

An idaifield_docs list

See Also

  • Alternative functions: idf_query(), idf_json_query()

Examples

## Not run: 
conn <- connect_idaifield(pwd = "hallo", project = "rtest")
uidlist <- get_field_index(conn)
idf_index_query(conn,
                field = "category",
                value = "Brick",
                uidlist = uidlist)

## End(Not run)


lsteinmann/idaifieldR documentation built on April 3, 2025, 2:06 p.m.