proj_idf_client: Create a Connection Client to a Field database (internal)

View source: R/connect_idaifield.R

proj_idf_clientR Documentation

Create a Connection Client to a Field database (internal)

Description

This function creates a crul::HttpClientobject for use in retrieving all documents from or querying a Field database associated with a specific project. This function is intended for internal use only.

Usage

proj_idf_client(conn, project = NULL, include = "all")

Arguments

conn

A connection object returned by connect_idaifield().

project

(deprecated) character. Name of the project-database that should be loaded.

include

Arguments: "all", "query", "changes" . Should the client use "_all_docs", "_find" or "_changes" as paths.

Value

A crul::HttpClient() object.

See Also

connect_idaifield() for information about connecting to Field and crul::HttpClient() which this function uses.

Examples

## Not run: 
  connection <- connect_idaifield(pwd = "hallo", project = "rtest")
  client <- proj_idf_client(conn = connection)

## End(Not run)

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