frame: Frame operations

frameR Documentation

Frame operations

Description

Frame operations

Usage

hirs_frame_create(index, frame, time_quantum = NULL, inverse_enabled = NULL,
  cache_type = "lru", cache_size = 50000L, range_enabled = NULL,
  fields = NULL, ...)

hirs_frame_delete(index, frame, ...)

hirs_frame_updatetq(index, frame, time_quantum, ...)

Arguments

index

(character) A character vector of index names

frame

(character) A frame name

time_quantum

(character) Time Quantum for this frame

inverse_enabled

(logical) Enables the inverted view for this frame if TRUE

cache_type

(character) ranked or LRU caching on this frame. Default: "lru"

cache_size

(integer) Number of rows to keep in the cache. Default: 50,000

range_enabled

(logical) Enables range-encoded fields in this frame

fields

(character) character vector of range-encoded fields

...

Curl args passed on to crul::HttpClient

Examples

## Not run: 
# first, create an index
hirs_index_create("hello")

# then, create a frame
hirs_frame_create("hello", "world")
hirs_frame_delete("hello", "world")

# update frame time quantum
hirs_frame_create("hello", "world")
hirs_frame_updatetq("hello", "world", time_quantum = "MD")

## End(Not run)

ropenscilabs/hirsutosa documentation built on May 11, 2022, 6:50 a.m.