Package 'fireData'

Description

Legacy anonymous login. Use auth_anonymous() instead.

Usage

anonymous_login(project_api)

Arguments

Value

Authentication response

Description

Legacy authentication function. Use auth_sign_in() instead.

Usage

auth(projectAPI, email = "prompt", password = "prompt")

Arguments

Value

Authentication response

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
auth(projectAPI = "AIzaSy...", email = "[email protected]", password = "password")
}

Description

Signs in a user anonymously. Anonymous users can be upgraded to full accounts later by linking credentials.

Usage

auth_anonymous(conn = NULL, api_key = NULL)

Arguments

Value

Authentication response containing idToken, refreshToken, and localId

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", api_key = "AIzaSy...")
result <- auth_anonymous(conn)
}

Description

Creates a new user account with email and password.

Usage

auth_create_user(conn = NULL, email = NULL, password = NULL, api_key = NULL)

Arguments

Value

Registration response containing idToken, email, refreshToken, expiresIn, and localId

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", api_key = "AIzaSy...")
result <- auth_create_user(conn, "[email protected]", "password123")
}

Description

Deletes the authenticated user's account.

Usage

auth_delete_user(conn = NULL, id_token = NULL, api_key = NULL)

Arguments

Value

Empty response on success

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
auth_delete_user(conn)
}

Description

Retrieves account info for the currently authenticated user.

Usage

auth_get_user(conn = NULL, id_token = NULL, api_key = NULL)

Arguments

Value

User account information

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
user_info <- auth_get_user(conn)
}

Description

Initiates Google OAuth flow and signs in to Firebase.

Usage

auth_google(
  conn = NULL,
  client_id = NULL,
  client_secret = NULL,
  request_uri,
  redirect_uri = httr::oauth_callback(),
  return_idp_credential = TRUE,
  cache = FALSE,
  api_key = NULL
)

Arguments

Value

Authentication response

Examples

if (interactive()) {
# Requires a configured Firebase project and OAuth client credentials.
result <- auth_google(
  conn,
  client_id = "your-client-id.apps.googleusercontent.com",
  client_secret = "your-secret",
  request_uri = "http://localhost"
)
}

Description

Signs in a user with OAuth credentials from a third-party provider.

Usage

auth_oauth(
  conn = NULL,
  request_uri,
  post_body,
  return_idp_credential = TRUE,
  api_key = NULL
)

Arguments

Value

Authentication response

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
# After obtaining OAuth token from provider
post_body <- "id_token=<google_id_token>&providerId=google.com"
result <- auth_oauth(conn, "http://localhost", post_body)
}

Description

Refreshes an expired ID token using a refresh token.

Usage

auth_refresh_token(conn = NULL, refresh_token, api_key = NULL)

Arguments

Value

Response containing new id_token, refresh_token, expires_in, token_type, and user_id

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
# Refresh using stored refresh token
new_tokens <- auth_refresh_token(conn, old_refresh_token)
}

Description

Sends a password reset email to the specified address.

Usage

auth_reset_password(conn = NULL, email, api_key = NULL)

Arguments

Value

Response indicating success

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
auth_reset_password(conn, "[email protected]")
}

Description

Authenticates a user with email and password credentials.

Usage

auth_sign_in(conn = NULL, email = NULL, password = NULL, api_key = NULL)

Arguments

Value

Authentication response containing idToken, refreshToken, localId, email, and expiresIn

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
# With connection object
conn <- firebase_connect(project_id = "my-project", api_key = "AIzaSy...")
result <- auth_sign_in(conn, "[email protected]", "password123")

# Update connection with token
conn <- firebase_set_token(conn, result)

# Without connection (uses config/environment)
result <- auth_sign_in(email = "[email protected]", password = "password123")
}

Description

Updates the display name and/or photo URL of the authenticated user.

Usage

auth_update_profile(
  conn = NULL,
  display_name = NULL,
  photo_url = NULL,
  id_token = NULL,
  api_key = NULL
)

Arguments

Value

Updated user data

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
auth_update_profile(conn, display_name = "John Doe")
}

Description

Factory function to create a FirebaseToken from an authentication response.

Usage

create_token(auth_response, api_key = NULL)

Arguments

Value

A FirebaseToken object

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
# After successful authentication
response <- auth_sign_in(conn, "[email protected]", "password")
token <- create_token(response, api_key = "your-api-key")
}

Description

Legacy user creation. Use auth_create_user() instead.

Usage

createUser(projectAPI, email = "prompt", password = "prompt")

Arguments

Value

Registration response

Description

Legacy backup function. Use rtdb_backup() instead.

Usage

dataBackup(projectURL, secretKey = "prompt", fileName)

Arguments

Value

File name

Description

Legacy delete function. Use rtdb_delete() instead.

Usage

delete(x, projectURL, directory = "main", token = "none")

Arguments

Value

Path

Description

Legacy function. Use storage_delete() instead.

Usage

delete_storage(
  bucket_name,
  object_name,
  web_client_id = "prompt",
  web_client_secret = "prompt"
)

Arguments

Value

NULL on success

Description

Legacy function to deploy R Markdown to storage. Rendering uses a temporary directory for output, intermediate files, and the knitting working directory. Use absolute paths for input resources in the document. Temporary render files are removed after the upload attempt.

Usage

deploy_rmarkdown(
  rmarkdown_path,
  bucket_name,
  object_name,
  web_client_id = "prompt",
  web_client_secret = "prompt"
)

Arguments

Value

Upload result

Description

Legacy download function. Use rtdb_get() instead.

Usage

download(
  projectURL,
  fileName,
  secretKey = "none",
  token = "none",
  isClass = FALSE
)

Arguments

Value

Downloaded data

Description

Legacy interface for the discontinued Firebase Dynamic Links service. Requests to the upstream service no longer succeed.

Usage

dynlink_create(
  conn = NULL,
  link,
  domain_uri_prefix,
  short = TRUE,
  social_title = NULL,
  social_description = NULL,
  social_image_link = NULL,
  android_package_name = NULL,
  android_fallback_link = NULL,
  ios_bundle_id = NULL,
  ios_fallback_link = NULL,
  api_key = NULL
)

Arguments

Value

This function always raises an error because the upstream service has been shut down.

Examples

# The retired service is unavailable; this reports an error without a request.
try(dynlink_create(
  link = "https://example.com/page",
  domain_uri_prefix = "https://example.page.link"
))

Description

Functions for user authentication with Firebase Auth

Description

Clears the connection's authentication state. Note that this doesn't actually close any persistent connections since the REST API is stateless.

Usage

firebase_close(conn)

Arguments

Value

Updated connection with cleared auth state

Description

Provides configuration loading and management for Firebase settings

Description

Clears session configuration values.

Usage

firebase_config_clear(keys = NULL)

Arguments

Value

Invisibly returns NULL

Examples

# Clear specific keys
firebase_config_clear(c("api_key", "project_id"))

# Clear all
firebase_config_clear()

Description

Retrieves a configuration value using the following priority:

1. Explicitly passed value

2. Session configuration (set via firebase_config_set)

3. Environment variables

4. Config file (~/.firedata/config.yml or .firedata.yml)

5. Default value

Usage

firebase_config_get(key, value = NULL, default = NULL, profile = "default")

Arguments

Value

The configuration value or default

Examples

# Get API key from environment or config
api_key <- firebase_config_get("api_key")

# Get with explicit value override
api_key <- firebase_config_get("api_key", value = "my-api-key")

Description

Loads configuration from a YAML file into session configuration.

Usage

firebase_config_load(path = NULL, profile = "default")

Arguments

Value

Invisibly returns the loaded configuration

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
# Load from default locations
firebase_config_load()

# Load specific file
firebase_config_load("path/to/config.yml")

# Load specific profile
firebase_config_load(profile = "production")
}

Description

Sets configuration values that persist for the current R session.

Usage

firebase_config_set(...)

Arguments

Value

Invisibly returns the previous values

Examples

firebase_config_set(
  project_id = "my-project",
  api_key = "AIzaSy..."
)
# Clear the example's session settings when finished
firebase_config_clear(c("project_id", "api_key"))

Description

Returns all currently set configuration values from all sources, with sensitive values masked. Use print() to display the returned list.

Usage

firebase_config_show(profile = "default")

Arguments

Value

Named list of all configuration values

Examples

# View current configuration
config <- firebase_config_show()
print(config)

Description

Guides the user through setting up Firebase configuration interactively.

Usage

firebase_config_wizard(save = FALSE, path = NULL)

Arguments

Value

Invisibly returns the configuration list

Examples

if (interactive()) {
# Run interactive setup
firebase_config_wizard()

# Optionally save to an explicitly chosen file
config_file <- tempfile(fileext = ".yml")
firebase_config_wizard(save = TRUE, path = config_file)
unlink(config_file)
}

Description

Creates a connection object that stores Firebase project configuration and can be passed to various fireData functions. The connection handles configuration resolution from multiple sources (arguments, environment, config files).

Usage

firebase_connect(
  project_id = NULL,
  api_key = NULL,
  database_url = NULL,
  storage_bucket = NULL,
  credentials = NULL,
  token = NULL
)

Arguments

Value

A firebase_connection S3 object

Examples

# Create connection with explicit values
conn <- firebase_connect(
  project_id = "my-project",
  api_key = "AIzaSy..."
)


# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
# These alternatives require your own configuration or credentials.
# Create connection from environment variables
# (Set FIREBASE_PROJECT_ID, FIREBASE_API_KEY, etc.)
conn <- firebase_connect()

# Create connection with service account
conn <- firebase_connect(
  project_id = "my-project",
  credentials = "path/to/service-account.json"
)
}

Description

Provides a connection object for Firebase operations

Description

Provides credential storage, retrieval, and token management

Description

Functions for creating Firebase Dynamic Links (short URLs)

Note

Firebase Dynamic Links shut down on August 25, 2025. These functions are retained for compatibility, but the upstream service no longer creates or serves links. Use another deep-linking provider for new projects.

Description

Functions for interacting with Google Cloud Firestore NoSQL database

Overview

Cloud Firestore is a flexible, scalable NoSQL cloud database. Unlike the Realtime Database which stores data as one large JSON tree, Firestore stores data in documents organized into collections.

Data Model

• Collections: Containers for documents (like folders)

• Documents: Individual records containing fields (like files)

• Fields: Key-value pairs within documents

• Subcollections: Collections nested within documents

Authentication

Firestore requires authentication. Use either:

• Service account credentials (recommended for server-side)

• User authentication token from auth_sign_in()

Description

Functions for CRUD operations on Firebase Realtime Database

Description

Updates the authentication token on a connection.

Usage

firebase_set_token(conn, token)

Arguments

Value

Updated connection object

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", api_key = "...")
auth_result <- auth_sign_in(conn, email, password)
conn <- firebase_set_token(conn, auth_result)
}

Description

Functions to integrate Firebase authentication with Shiny apps

Description

Functions for file storage operations with Firebase/Google Cloud Storage

Description

Internal utility functions for data conversion and path handling

Description

Represents an authenticated Firebase token with automatic refresh capability.

Public fields

Methods

Public methods

• FirebaseToken$new()

• FirebaseToken$is_expired()

• FirebaseToken$refresh()

• FirebaseToken$get_token()

• FirebaseToken$print()

• FirebaseToken$clone()

Method new()

Usage

FirebaseToken$new(auth_response, api_key = NULL)

Arguments

Returns

A new FirebaseToken object Check if token is expired

Method is_expired()

Usage

FirebaseToken$is_expired(buffer_seconds = 300)

Arguments

Returns

TRUE if token is expired or will expire within buffer Refresh the token if expired

Method refresh()

Usage

FirebaseToken$refresh(force = FALSE)

Arguments

Returns

Self (invisibly) Get the current valid token

Automatically refreshes if expired.

Method get_token()

Usage

FirebaseToken$get_token()

Returns

The ID token string Print token summary

Method print()

Usage

FirebaseToken$print(...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

FirebaseToken$clone(deep = FALSE)

Arguments

Description

Creates a new document with an auto-generated ID.

Usage

firestore_add(conn = NULL, collection, data, project_id = NULL, token = NULL)

Arguments

Value

The created document data including the generated ID

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project")

# Add document with auto-generated ID
result <- firestore_add(conn, "messages", list(
  text = "Hello, Firestore!",
  timestamp = Sys.time(),
  author = "R User"
))

# Get the generated document ID
print(result$.id)
}

Description

Deletes a document from Cloud Firestore.

Usage

firestore_delete(
  conn = NULL,
  collection,
  document,
  project_id = NULL,
  token = NULL
)

Arguments

Value

TRUE if successful

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project")

# Delete a document
firestore_delete(conn, "users", "user123")
}

Description

Retrieves a single document from Cloud Firestore.

Usage

firestore_get(
  conn = NULL,
  collection,
  document,
  project_id = NULL,
  token = NULL
)

Arguments

Value

Document data as a list, or NULL if not found

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project")
conn <- firebase_set_token(conn, auth_sign_in(conn, "[email protected]", "password"))

# Get a single document
user <- firestore_get(conn, "users", "user123")
print(user$name)

# Get from subcollection
post <- firestore_get(conn, "users/user123/posts", "post456")
}

Description

Lists documents in a collection.

Usage

firestore_list(
  conn = NULL,
  collection,
  page_size = 100,
  page_token = NULL,
  order_by = NULL,
  project_id = NULL,
  token = NULL
)

Arguments

Value

List containing documents and optional nextPageToken

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project")

# List all users (up to 100)
result <- firestore_list(conn, "users")
for (user in result$documents) {
  print(user$name)
}

# Paginate through results
result <- firestore_list(conn, "users", page_size = 10)
while (!is.null(result$nextPageToken)) {
  result <- firestore_list(conn, "users", page_size = 10,
                           page_token = result$nextPageToken)
}
}

Description

Runs a structured query against a Firestore collection.

Usage

firestore_query(conn = NULL, collection, project_id = NULL, token = NULL)

Arguments

Value

A firestore_query object for building the query

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project")

# Query with filters
results <- firestore_query(conn, "users") |>
  fs_where("age", ">=", 18) |>
  fs_where("active", "==", TRUE) |>
  fs_order_by("name") |>
  fs_limit(10) |>
  fs_execute()
}

Description

Creates or overwrites a document in Cloud Firestore.

Usage

firestore_set(
  conn = NULL,
  collection,
  document,
  data,
  project_id = NULL,
  token = NULL
)

Arguments

Value

The created/updated document data

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project")

# Create or overwrite a document
firestore_set(conn, "users", "user123", list(
  name = "John Doe",
  email = "[email protected]",
  age = 30,
  active = TRUE
))
}

Description

Updates specific fields in a document without overwriting the entire document.

Usage

firestore_update(
  conn = NULL,
  collection,
  document,
  data,
  project_id = NULL,
  token = NULL
)

Arguments

Value

The updated document data

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project")

# Update only specific fields
firestore_update(conn, "users", "user123", list(
  lastLogin = Sys.time(),
  loginCount = 42
))
}

Description

Executes a Firestore query and returns the results.

Usage

fs_execute(query)

Arguments

Value

List of documents matching the query

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
results <- firestore_query(conn, "products") |>
  fs_where("price", "<", 100) |>
  fs_order_by("price", "asc") |>
  fs_limit(20) |>
  fs_execute()
}

Description

Limits the number of documents returned by a query.

Usage

fs_limit(query, n)

Arguments

Value

Updated firestore_query object

Description

Skips a number of documents before returning results.

Usage

fs_offset(query, n)

Arguments

Value

Updated firestore_query object

Description

Adds ordering to a Firestore query.

Usage

fs_order_by(query, field, direction = "asc")

Arguments

Value

Updated firestore_query object

Description

Specifies which fields to return in query results.

Usage

fs_select(query, ...)

Arguments

Value

Updated firestore_query object

Description

Adds a field filter to a Firestore query.

Usage

fs_where(query, field, op, value)

Arguments

Value

Updated firestore_query object

Examples

conn <- firebase_connect(project_id = "my-project")
query <- firestore_query(conn, "users") |>
  fs_where("age", ">=", 21) |>
  fs_where("status", "==", "active")

Description

Legacy function. Use dynlink_create() instead.

Usage

get_dynamic_link(
  project_api,
  domain,
  link,
  short = TRUE,
  social_title = "",
  social_description = "",
  social_image_link = ""
)

Arguments

Value

This function always raises an error because the upstream service has been shut down.

Description

Legacy function. Use storage_get_metadata() instead.

Usage

get_storage(
  bucket_name,
  object_name,
  web_client_id = "prompt",
  web_client_secret = "prompt"
)

Arguments

Value

Object metadata

Description

Legacy function. Use storage_get_url() instead.

Usage

get_url(
  bucket_name,
  object_name,
  web_client_id = "prompt",
  web_client_secret = "prompt"
)

Arguments

Value

Download URL

Description

Gets the Firebase token from authenticated user in Shiny context.

Usage

get_user_token(user)

Arguments

Value

The ID token string or NULL if not authenticated

Description

Legacy function for OAuth token.

Usage

google_devstorage_read_only(
  web_client_id = "prompt",
  web_client_secret = "prompt"
)

Arguments

Value

OAuth token

Description

Legacy function for OAuth token.

Usage

google_devstorage_read_write(
  web_client_id = "prompt",
  web_client_secret = "prompt"
)

Arguments

Value

OAuth token

Description

Legacy function for Firestore OAuth token.

Usage

google_firestore(
  web_client_id = "prompt",
  web_client_secret = "prompt",
  cache = FALSE
)

Arguments

Value

OAuth token

Description

Legacy Google login. Use auth_google() instead.

Usage

google_login(
  project_api,
  web_client_id = "prompt",
  web_client_secret = "prompt",
  request_uri,
  redirect_uri = httr::oauth_callback(),
  return_idp_credential = TRUE,
  cache = FALSE
)

Arguments

Value

Authentication response

Description

Helper to check if user is authenticated in Shiny context.

Usage

is_authenticated(user)

Arguments

Value

TRUE if user is logged in, FALSE otherwise

Description

Check if Object is a Firebase Connection

Usage

is_firebase_connection(x)

Arguments

Value

TRUE if x is a firebase_connection

Description

Legacy function. Use storage_list() instead.

Usage

list_storage(
  bucket_name,
  web_client_id = "prompt",
  web_client_secret = "prompt"
)

Arguments

Value

List of objects

Description

Creates ServiceAccountCredentials from a file or environment.

Usage

load_service_account(path = NULL)

Arguments

Value

A ServiceAccountCredentials object

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
# From file
creds <- load_service_account("path/to/service-account.json")

# From GOOGLE_APPLICATION_CREDENTIALS environment variable
creds <- load_service_account()
}

Description

Legacy OAuth login. Use auth_oauth() instead.

Usage

o_auth_login(project_api, request_uri, post_body, return_idp_credential)

Arguments

Value

Authentication response

Description

Functions to obtain OAuth2 tokens for various Google/Firebase services.

Description

Legacy patch function. Use rtdb_update() instead.

Usage

patch(x, projectURL, directory = "main", token = "none")

Arguments

Value

Path

Description

Replaces disallowed characters in Firebase paths with hyphens. Firebase paths cannot contain: . $ # [ ] /

[ ]: R:%20

Usage

path_sanitize(path)

path_check(path)

Arguments

Value

The sanitized path string

Examples

# Path with invalid characters
path_sanitize("users/john.doe")
# Returns: "users-john-doe" with a warning

# Valid path passes through unchanged
path_sanitize("users-johndoe")
# Returns: "users-johndoe"

Description

Print Firebase Connection

Usage

## S3 method for class 'firebase_connection'
print(x, ...)

Arguments

Value

Invisibly returns x

Description

Print Firestore Query

Usage

## S3 method for class 'firestore_query'
print(x, ...)

Arguments

Value

Invisibly returns x

Description

Print Query

Usage

## S3 method for class 'rtdb_query'
print(x, ...)

Arguments

Value

Invisibly returns x

Description

Legacy put function. Use rtdb_set() instead.

Usage

put(x, projectURL, directory = "main", token = "none")

Arguments

Value

Path

Description

End Query at Value

Usage

query_end_at(query, value)

Arguments

Value

Updated query builder

Description

Filter Query by Exact Value

Usage

query_equal_to(query, value)

Arguments

Value

Updated query builder

Description

Execute Query

Usage

query_execute(query, token = NULL)

Arguments

Value

Query results

Description

Limit Query to First N Results

Usage

query_limit_to_first(query, n)

Arguments

Value

Updated query builder

Description

Limit Query to Last N Results

Usage

query_limit_to_last(query, n)

Arguments

Value

Updated query builder

Description

Order Query by Field

Usage

query_order_by(query, field)

Arguments

Value

Updated query builder

Description

Start Query at Value

Usage

query_start_at(query, value)

Arguments

Value

Updated query builder

Description

Legacy password reset. Use auth_reset_password() instead.

Usage

resetPassword(projectAPI, email)

Arguments

Value

Success or warning message

Description

Downloads the entire database to a JSON file.

Usage

rtdb_backup(conn, file_name, token = NULL)

Arguments

Value

The file name where backup was saved

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(
  project_id = "my-project",
  credentials = "service-account.json"
)
backup_file <- tempfile(fileext = ".json")
rtdb_backup(conn, backup_file)
unlink(backup_file)
}

Description

Removes data at the specified path.

Usage

rtdb_delete(conn, path, token = NULL)

Arguments

Value

The path that was deleted

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", api_key = "...")

# Delete user
rtdb_delete(conn, "users/user123")
}

Description

Retrieves data from the specified path in the Realtime Database.

Usage

rtdb_get(conn, path, shallow = FALSE, is_class = FALSE, token = NULL)

Arguments

Value

The data at the specified path, or NULL if not found

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", api_key = "...")

# Get all users
users <- rtdb_get(conn, "users")

# Get specific user
user <- rtdb_get(conn, "users/user123")

# Get only keys (shallow read)
keys <- rtdb_get(conn, "users", shallow = TRUE)
}

Description

Adds data to a list with an auto-generated unique key.

Usage

rtdb_push(conn, path, data, token = NULL)

Arguments

Value

The full path including the generated key

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", api_key = "...")

# Push new message (auto-generates key)
path <- rtdb_push(conn, "messages", list(text = "Hello", timestamp = Sys.time()))
# Returns something like "messages/-NxYz..."
}

Description

Creates a query builder for filtering and sorting database queries.

Usage

rtdb_query(conn, path)

Arguments

Value

A query builder object

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", api_key = "...")

# Query users ordered by age, limited to 10
results <- rtdb_query(conn, "users") |>
  query_order_by("age") |>
  query_start_at(18) |>
  query_limit_to_first(10) |>
  query_execute()
}

Description

Writes data to the specified path, overwriting any existing data. Use rtdb_update() for partial updates.

Usage

rtdb_set(conn, path, data, token = NULL)

Arguments

Value

The path where data was written

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", api_key = "...")

# Set user data
rtdb_set(conn, "users/user123", list(name = "John", age = 30))

# Set data frame
rtdb_set(conn, "data/mtcars", mtcars)
}

Description

Updates specific fields at the specified path without overwriting other existing data. Use rtdb_set() to completely overwrite.

Usage

rtdb_update(conn, path, data, token = NULL)

Arguments

Value

The path where data was updated

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", api_key = "...")

# Update only the age field
rtdb_update(conn, "users/user123", list(age = 31))
}

Description

Creates a login overlay for Shiny applications with support for email/password, Google OAuth, and anonymous authentication.

Usage

shiny_auth_server(
  user,
  input,
  output,
  credentials = TRUE,
  goauth = TRUE,
  anonymous = TRUE,
  project_api = NULL,
  web_client_id = NULL,
  web_client_secret = NULL,
  request_uri = NULL
)

Arguments

Value

A Shiny UI element containing the login form

Examples

if (interactive()) {
library(shiny)
library(fireData)

ui <- fluidPage(
  shinyjs::useShinyjs(),
  uiOutput("app")
)

server <- function(input, output, session) {
  USER <- reactiveValues(Logged = FALSE)

  output$app <- renderUI({
    if (!USER$Logged) {
      shiny_auth_server(
        user = USER,
        input = input,
        output = output,
        project_api = "your-api-key",
        web_client_id = "your-client-id",
        web_client_secret = "your-client-secret",
        request_uri = "http://localhost"
      )
    } else {
      # Your main app UI
      tagList(
        h1("Welcome!"),
        actionButton("logout", "Logout")
      )
    }
  })
}

shinyApp(ui, server)
}

Description

Creates a styled login panel for Shiny apps. Use with shiny_auth_server() for complete authentication.

Usage

shiny_auth_ui(title = "Sign In")

Arguments

Value

A Shiny UI element

Examples

if (interactive()) {
ui <- shiny::fluidPage(
  shinyjs::useShinyjs(),
  shiny_auth_ui("Sign In")
)
}

Description

Deletes a file from Firebase Cloud Storage.

Usage

storage_delete(conn, object_name, client_id = NULL, client_secret = NULL)

Arguments

Value

NULL on success

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
storage_delete(conn, "images/old-photo.jpg")
}

Description

Downloads a file from Firebase Cloud Storage.

Usage

storage_download(
  conn,
  object_name,
  dest_file = NULL,
  client_id = NULL,
  client_secret = NULL
)

Arguments

Value

If dest_file is NULL, returns file content; otherwise returns dest_file path

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
# Download to file
dest_file <- tempfile(fileext = ".jpg")
storage_download(conn, "images/photo.jpg", dest_file)
unlink(dest_file)

# Download to memory
content <- storage_download(conn, "data/config.json")
}

Description

Retrieves metadata for a storage object.

Usage

storage_get_metadata(conn, object_name, client_id = NULL, client_secret = NULL)

Arguments

Value

Object metadata

Description

Generates a download URL for a storage object.

Usage

storage_get_url(conn, object_name, client_id = NULL, client_secret = NULL)

Arguments

Value

Download URL string

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
url <- storage_get_url(conn, "images/photo.jpg")
if (interactive()) {
  utils::browseURL(url)
}
}

Description

Lists all files in a storage bucket or prefix.

Usage

storage_list(
  conn,
  prefix = NULL,
  delimiter = NULL,
  max_results = 1000,
  client_id = NULL,
  client_secret = NULL
)

Arguments

Value

List of storage objects

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
# List all files
files <- storage_list(conn)

# List files in a "folder"
images <- storage_list(conn, prefix = "images/")
}

Description

Uploads a file to Firebase Cloud Storage.

Usage

storage_upload(
  conn,
  file_path,
  object_name,
  content_type = NULL,
  predefined_acl = NULL,
  client_id = NULL,
  client_secret = NULL
)

Arguments

Value

Storage object metadata including URL

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
conn <- firebase_connect(project_id = "my-project", storage_bucket = "my-bucket")

# Upload with service account
result <- storage_upload(conn, "local/photo.jpg", "images/photo.jpg")

# Get the public URL
print(result$url)
}

Description

Uploads all files from a local folder to storage.

Usage

storage_upload_folder(
  conn,
  folder_path,
  prefix = "",
  client_id = NULL,
  client_secret = NULL
)

Arguments

Value

List of upload results

Examples

# Requires your own Firebase configuration, credentials and example resources.
# Adapt the placeholders and set FIREDATA_RUN_EXAMPLES=true to opt in.
if (identical(Sys.getenv("FIREDATA_RUN_EXAMPLES"), "true")) {
results <- storage_upload_folder(conn, "local/images", "images")
}

Description

Legacy upload function. Use rtdb_push() instead.

Usage

upload(x, projectURL, directory = "main", token = "none")

Arguments

Value

Path with generated key

Description

Legacy function. Use storage_upload_folder() instead.

Usage

upload_folder(
  bucket_name,
  web_client_id = "prompt",
  web_client_secret = "prompt",
  folder_path
)

Arguments

Value

List of upload results

Description

Legacy function. Use storage_upload() instead.

Usage

upload_storage(
  bucket_name,
  object_name,
  web_client_id = "prompt",
  web_client_secret = "prompt",
  file_path = NULL,
  predefined_acl = "publicRead"
)

Arguments

Value

Storage object metadata