list_groups: Show listing of groups
In TileDB-Inc/TileDB-Cloud-R: TileDB Cloud Platform R Client Package

list_groups

R Documentation

Show listing of groups

Description

Returns a dataframe of metadata for all groups that meet the filter applied.

Usage

list_groups(
  public = FALSE,
  shared = FALSE,
  page = NULL,
  per.page = NULL,
  search = NULL,
  namespace = NULL,
  orderby = NULL,
  permissions = NULL,
  tag = NULL,
  exclude.tag = NULL,
  flat = FALSE,
  parent = NULL
)

Arguments

`public`	logical TRUE means list public arrays
`shared`	logical TRUE means list shared arrays. If `public` and `shared` are both false then arrays owned by you are listed.
`page`	integer
`per.page`	integer
`search`	character
`namespace`	character
`orderby`	character
`permissions`	character
`tag`	list( character )
`exclude.tag`	list( character )
`flat`	logical, if 'TRUE', ignores the nesting of groups and searches all of them
`parent`	character, search only the children of the groups with this uuid

Details

Note that this is a paginable API but default params return all results on one call, even hundreds of them.

Pagination information is set as an attribute of the returned data frame.

Value

A 'data.frame' of metadata for all groups in your account that meet the filter applied.

Other manual-layer functions: array_info(), compute_sequentially(), compute(), delayed_args<-(), delayed_args(), delayed_array_udf(), delayed_generic_udf(), delayed_sql(), delayed(), deregister_array(), deregister_group(), deregister_udf(), execute_array_udf(), execute_generic_udf(), execute_multi_array_udf(), execute_sql_query(), get_udf_info(), group_info(), list_arrays(), login(), register_array(), register_udf(), update_udf_info(), user_profile()