NoSQLResourceClient: NoSQL database resource client

In resourcer: Resource Resolver

NoSQL database resource client

Description

NoSQL database resource client

NoSQL database resource client

Format

A R6 object of class NoSQLResourceClient

Details

Resource client that connects to a NoSQL database supported by nodbi.

Super class

resourcer::ResourceClient -> NoSQLResourceClient

Methods

Public methods

• NoSQLResourceClient$new()

• NoSQLResourceClient$getConnection()

• NoSQLResourceClient$asDataFrame()

• NoSQLResourceClient$getDatabaseName()

• NoSQLResourceClient$getTableName()

• NoSQLResourceClient$close()

• NoSQLResourceClient$clone()

Inherited methods

• resourcer::ResourceClient$asTbl()
• resourcer::ResourceClient$downloadFile()
• resourcer::ResourceClient$exec()
• resourcer::ResourceClient$getResource()

---

Method new()

Creates a new NoSQLResourceClient instance.

Usage

NoSQLResourceClient$new(resource)

Arguments

resource

A valid resource object.

Returns

A NoSQLResourceClient object.

---

Method getConnection()

Creates the nodbi connection object if it does not exist.

Usage

NoSQLResourceClient$getConnection()

Returns

The nodbi connection object.

---

Method asDataFrame()

Makes a data.frame from the remote database table.

Usage

NoSQLResourceClient$asDataFrame()

Returns

A tibble.

---

Method getDatabaseName()

Extract the database name from the resource URL.

Usage

NoSQLResourceClient$getDatabaseName()

Returns

The database name.

---

Method getTableName()

Extract the database table name from the resource URL.

Usage

NoSQLResourceClient$getTableName()

Returns

The database table name.

---

Method close()

Close the nodbi connection.

Usage

NoSQLResourceClient$close()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

NoSQLResourceClient$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

resourcer documentation built on April 25, 2023, 5:10 p.m.