Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To get a holistic view of collections, we categorize them into the following sections:

Click here for the collection Collection management tutorial.

Purpose

...

See ClearBlade Platform SDK for the Collection API.

Data

...

model queries

Data Model allows model queries allow developers to run raw SQL queries on the platform and edge instead of using the existing ClearBlade Query Modelquery model. These SQL queries can run against collection, user, and device tables. Developers should use the data model when running operations such as JOIN and other operations not supported by the ClearBlade Query Modelquery model.

See ClearBlade Native Librariesnative libraries for the API.

Collection

...

types

Cloud

ClearBlade provides a default cloud collection backed by a PostgreSQL instance. The platform can manipulate these collections regarding their schema and the data put into them.

...

Field

Description

Example

Database Type

DB Application Typeapplication type

MySQL

IP Address

Database URL

mydb.databases.com

Port

Port number on which the application is running

5432

Database Name

Database name

dbname

Connection Name

String

example

Table Name

String

sensor_data

Username

String

admin

Password

String

zrHcnzpBenHSOIq0uK/og8R

Column

...

types

Type

Description

string

Series of characters. Example: Column 1

integer (int)

Positive or negative whole number

boolean (bool)

True/Falsefalse

timestamp

03/29/21 22:15:07

float

Numbers with decimals

bigint

Large whole numbers

double

Large numbers with decimals

jsonb

See below

binary large object (blob)

A binary data collection stored as a single entity

universally unique identifier (uuid)

A 128-bit unique identification value. Example: bc37d0c0-fcf2-11d9-8cd6-0800200c9a66

...

Click here for an operator and function list.

Index/

...

unique index

Collection columns can be indexed to speed up certain database operations. Unique indexing allows unique values to be used. The async library for indexing can be found under the Collection section. To configure indexing, go to the Edit column in a collection and mark the indexing box type under the column(s) you choose.

...