vignettes/articles/connectapi_tags.Rmd
connectapi_tags.Rmd
To understand how tags work with connectapi
, you must
first understand tags in RStudio Connect.
As always, get started by defining the CONNECT_SERVER
and CONNECT_API_KEY
variables, then initialize an API
client.
library(connectapi)
client <- connect()
NOTE: This example report will create a few tag hierarchies and then use them. As a result, to use this example verbatim requires admin privileges and will create tags on your server.
To get started, we will create a tag tree to show how things work.
The create_tag()
helper allows you to create a singular tag
(by specifying its parent, etc.). For our purposes,
create_tag_tree()
is easier, since it creates the entire
tree specified at once.
start_tags <- get_tags(client)
start_tags
## Posit Connect Tag Tree
## < No tags >
tree_project_1 <- create_tag_tree(client, "DemoProject", "project_1")
## Posit Connect Tag Tree (filtered)
## └── DemoProject
## └── project_1
tree_project_1
## Posit Connect API Client:
## Posit Connect Server: http://localhost:32768
## Posit Connect API Key: ***********GfKh
tmp_tags <- get_tags(client)
tree_project_2 <- create_tag(client, name = "project_2", parent = tmp_tags$DemoProject)
## Posit Connect Tag Tree (filtered)
## └── DemoProject
## └── project_2
tree_project_2
## Posit Connect API Client:
## Posit Connect Server: http://localhost:32768
## Posit Connect API Key: ***********GfKh
tree_audience_1 <- create_tag_tree(client, "DemoAudience", "Sales")
## Posit Connect Tag Tree (filtered)
## └── DemoAudience
## └── Sales
tree_audience_2 <- create_tag_tree(client, "DemoAudience", "Finance")
## Posit Connect Tag Tree (filtered)
## └── DemoAudience
## └── Finance
get_tags(client)
## Posit Connect Tag Tree
## ├── DemoProject
## │ ├── project_1
## │ └── project_2
## └── DemoAudience
## ├── Sales
## └── Finance
In order to show how tags work, we need some content to work with.
bnd <- bundle_static(system.file("logo.png", package = "connectapi"))
## Bundling directory (/tmp/RtmpDWxtVz/bundledir1ec611ea8ee7)
content_1 <- deploy(client, bnd)
## Getting content endpoint
## Found EXISTING content 41f8fb93-7cbc-4e8b-a4ac-a6f2403dcee5 with name mwlefoodfieexombwkkeulbfd on http://localhost:32768
## Uploading bundle
## Deploying bundle
content_2 <- deploy(client, bnd)
## Getting content endpoint
##
## Uploading bundle
## Deploying bundle
Content 1 is for project_1
and Sales
, so
let’s set the tags! There are a few ways to do so.
all_tags <- get_tags(client)
set_content_tag_tree(content_1, "DemoProject", "project_1")
## Posit Connect Tag Tree (content)
## └── DemoProject
## └── project_1
## Posit Connect Content Task:
## Content GUID: 41f8fb93-7cbc-4e8b-a4ac-a6f2403dcee5
## URL: http://localhost:32768/connect/#/apps/41f8fb93-7cbc-4e8b-a4ac-a6f2403dcee5/
## Task ID: W3AAPzJjcKoY0Faz
set_content_tags(content_1, all_tags$DemoAudience$Sales)
## Posit Connect Tag Tree (content)
## ├── DemoProject
## │ └── project_1
## └── DemoAudience
## └── Sales
## Posit Connect Content Task:
## Content GUID: 41f8fb93-7cbc-4e8b-a4ac-a6f2403dcee5
## URL: http://localhost:32768/connect/#/apps/41f8fb93-7cbc-4e8b-a4ac-a6f2403dcee5/
## Task ID: W3AAPzJjcKoY0Faz
Content 2 is for project_2
and both Audiences
(Sales
and Finance
).
set_content_tags(
content_2,
all_tags$DemoProject$project_2,
all_tags$DemoAudience$Sales,
all_tags$DemoAudience$Finance
)
## Posit Connect Tag Tree (content)
## ├── DemoProject
## │ └── project_2
## └── DemoAudience
## ├── Sales
## └── Finance
## Posit Connect Content Task:
## Content GUID: 669af4cc-055d-4eb0-9b89-e340e0d0e840
## URL: http://localhost:32768/connect/#/apps/669af4cc-055d-4eb0-9b89-e340e0d0e840/
## Task ID: zZdUXmxCzh3cr77e
In order to see the tags associated with content, use
get_content_tags()
. The data structure is the same as
get_tags()
, but the “whole list” is filtered to only the
tags that are associated with a piece of content.
c1_tags <- get_content_tags(content_1)
c1_tags
## Posit Connect Tag Tree (content)
## ├── DemoProject
## │ └── project_1
## └── DemoAudience
## └── Sales
c2_tags <- get_content_tags(content_2)
c2_tags
## Posit Connect Tag Tree (content)
## ├── DemoProject
## │ └── project_2
## └── DemoAudience
## ├── Sales
## └── Finance
Once tags have been defined, you can also search for all of the content associated with a tag.
content_list_by_tag(client, all_tags$DemoAudience$Sales)
## # A tibble: 2 × 44
## guid name title description access_type connection_timeout read_timeout
## <chr> <chr> <chr> <chr> <chr> <int> <int>
## 1 669af4cc-… pbcy… pbcy… "" acl NA NA
## 2 41f8fb93-… mwle… mwle… "" acl NA NA
## # ℹ 37 more variables: init_timeout <int>, idle_timeout <int>,
## # max_processes <int>, min_processes <int>, max_conns_per_process <int>,
## # load_factor <dbl>, memory_request <lgl>, memory_limit <lgl>,
## # cpu_request <lgl>, cpu_limit <lgl>, amd_gpu_limit <lgl>,
## # nvidia_gpu_limit <lgl>, service_account_name <lgl>,
## # default_image_name <lgl>, created_time <dttm>, last_deployed_time <dttm>,
## # bundle_id <chr>, app_mode <chr>, content_category <chr>, …
content_list_by_tag(client, all_tags$DemoProject$project_1)
## # A tibble: 1 × 44
## guid name title description access_type connection_timeout read_timeout
## <chr> <chr> <chr> <chr> <chr> <int> <int>
## 1 41f8fb93-… mwle… mwle… "" acl NA NA
## # ℹ 37 more variables: init_timeout <int>, idle_timeout <int>,
## # max_processes <int>, min_processes <int>, max_conns_per_process <int>,
## # load_factor <dbl>, memory_request <lgl>, memory_limit <lgl>,
## # cpu_request <lgl>, cpu_limit <lgl>, amd_gpu_limit <lgl>,
## # nvidia_gpu_limit <lgl>, service_account_name <lgl>,
## # default_image_name <lgl>, created_time <dttm>, last_deployed_time <dttm>,
## # bundle_id <chr>, app_mode <chr>, content_category <chr>, …
content_list_by_tag(client, all_tags$DemoProject)
## # A tibble: 0 × 32
## # ℹ 32 variables: guid <chr>, name <chr>, title <chr>, description <chr>,
## # access_type <chr>, connection_timeout <int>, read_timeout <int>,
## # init_timeout <int>, idle_timeout <int>, max_processes <int>,
## # min_processes <int>, max_conns_per_process <int>, load_factor <dbl>,
## # created_time <dttm>, last_deployed_time <dttm>, bundle_id <chr>,
## # app_mode <chr>, content_category <chr>, parameterized <lgl>,
## # cluster_name <chr>, image_name <chr>, r_version <chr>, py_version <chr>, …
Now we will clean up the demo tags that we created.
# Protect against tags already existing
if ("DemoProject" %in% names(start_tags) || "DemoAudience" %in% names(start_tags)) {
stop("ERROR: One of the demo tags already exist for you! Beware lest they be deleted by this demo")
}
latest_tags <- get_tags(client)
delete_tag(client, latest_tags$DemoProject)
## Posit Connect API Client:
## Posit Connect Server: http://localhost:32768
## Posit Connect API Key: ***********GfKh
delete_tag(client, latest_tags$DemoAudience)
## Posit Connect API Client:
## Posit Connect Server: http://localhost:32768
## Posit Connect API Key: ***********GfKh
# TODO: delete content