coleo_request_general: Requête générale sur coleo de type 'GET'

In ReseauBiodiversiteQuebec/rcoleo: rcoleo

Requête générale sur coleo de type 'GET'

Description

Cette fonction permet de faire une requête sur l'API de coleo. Les requêtes de type GET se font sur le schéma api.

Usage

coleo_request_general(
  endpoint,
  perform = TRUE,
  response_as_df = FALSE,
  schema = "api",
  page_size = 10000,
  ...
)

Arguments

endpoint	Nom du endpoint de l'API de coleo sur lequel la requête doit être effectuée. Si la requête est faite sur une fonction, il est nécessaire d'ajouter 'rpc/' devant le nom de la fonction.
perform	TRUE par default. Retourne un objet httr2 request et pas de requête effectuée si FALSE.
response_as_df	FALSE par défaut. Retroune un data.frame si TRUE.
schema	Schema qui contient les fonctions ou tables de l'appel.
page_size	Nombre d'items par page. Par défaut, 10000.
...	Paramètres de requête pour la base de données coleo (dans le format 'nom' = 'valeur')

Value

Liste d'objects JSON parsed si perform = TRUE et un tibble si response_as_df = TRUE, un objet httr2 request si perform = FALSE.

Examples

# Requête sur la table 'cells'
coleo_request_general('cells', perform = FALSE, response_as_df = TRUE, schema = 'public')

# Requête sur la fonction 'table_columns'
coleo_request_general('rpc/table_columns', perform = FALSE, response_as_df = TRUE, 
'table_name' = 'cells')

ReseauBiodiversiteQuebec/rcoleo documentation built on July 16, 2025, 9:11 p.m.