The bit.io Developer Hub

Welcome to the bit.io developer hub. You'll find comprehensive guides and documentation to help you start working with bit.io as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Supported SQL

bit.io's functionality maps onto the PostgreSQL 12 standard, meaning users can employ PostgreSQL syntax to create, delete, and modify their repositories, tables, and views. However, bit.io does not support every PostgreSQL construct, so we've outlined our current support below.

📘

Repositories in bit.io map onto schemas in PostgreSQL, so we will refer to schemas as repositories throughout the documentation.

SQL Statements

We support the following PostgreSQL commands:

Statement

Description

Documentation

ALTER TABLE

change a table's definition

ALTER TABLE Documentation

ALTER VIEW

change a view's definition

ALTER VIEW Documentation

COPY

copy data rows to/from a table or view

COPY Documentation

CREATE TABLE

define a new table

CREATE TABLE Documentation

CREATE VIEW

define a new view

CREATE VIEW Documentation

DELETE

delete rows from a table or view

DELETE Documentation

DROP TABLE

delete a table instance

DROP TABLE Documentation

DROP VIEW

delete a view instance

DROP VIEW Documentation

INSERT

insert data rows into a table or view

INSERT Documentation

SELECT

retrieve data rows from a set of tables or views

SELECT Documentation

TRUNCATE

delete all rows from a table or view

TRUNCATE Documentation

UPDATE

change the contents of a table or view's data rows

UPDATE Documentation

VALUES

compute a set of data rows

VALUES Documentation

SQL Types

Supported SQL data types include:

Type

Examples

Documentation

Integer & Float

INTEGER, REAL

Integer & Float Types Documentation

Character

TEXT, VARCHAR

Character Types Documentation

Binary Data

bytea

Binary Data Types Documentation

Date/Time

DATE, TIMESTAMP

Date/Time Types Documentation

Boolean

BOOLEAN

Boolean Types Documentation

Bit String

BIT(n), VARBIT(n)

Bit String Types Documentation

JSON

JSON, JSONB

JSON Types Documentation

Schema Definitions

Type

Supported

Documentation

Define a new repository

only in web app

CREATE SCHEMA is currently unsupported

Define a new table

CREATE TABLE Documentation

Define a new view

CREATE VIEW Documentation

Modify a repository

only in web app

ALTER SCHEMA is currently unsupported

Rename a table

ALTER TABLE Documentation

Modify a view's definition

𐄂

ALTER VIEW Documentation

Add columns to a table

ALTER TABLE Documentation

Rename a table's columns

ALTER TABLE Documentation

Modify a column's data type

ALTER TABLE Documentation

Modify a column's default value

ALTER TABLE Documentation

Modify a column's null status

ALTER TABLE Documentation

Delete columns from a table

ALTER TABLE Documentation

Delete a repository

only in web app

DROP SCHEMA is currently unsupported

Delete a table

DROP TABLE Documentation

Delete a view

DROP VIEW Documentation

System Catalogs

The Postgres system catalogs is the schema pg_catalog which includes tables with information about the metadata of objects in the database. We support read only operations on the following pg_catalog tables:

Table

Description

Operations

Documentation

pg_attribute

stores information about a table's columns

read only

pg_attribute Documentation

pg_class

stores information about tables and views

read only

pg_class Documentation

pg_namespace

stores information about repositories

read only

pg_namespace Documentation

pg_tables

stores information about tables

read only

pg_tables Documentation

pg_views

stores information about views

read only

pg_views Documentation

The Information Schema

The information_schema schema contains views documenting the metadata about database objects according to the SQL standard. We support read-only operations on the following information_schema views:

View

Description

Operations

Documentation

schemata

stores information about repositories

read only

information_schema.schemata Documentation

tables

stores information about tables

read only

information_schema.tables Documentation

columns

stores information about repositories

read only

information_schema.columns Documentation

views

stores information about views

read only

information_schema.views Documentation

SQL Identifiers

Identifiers are tokens that identify the name of repositories, tables, columns, and views. We support the following types of identifiers:

Type

Supported

Documentation

Unquoted Identifiers

Unquoted Identifiers Documentation

Quoted Identifiers

Quoted Identifiers Documentation

Unicode Identifiers

Unicode Identifiers Documentation

Transactions

bit.io does not currently support transactions, which includes BEGIN, START TRANSACTION, COMMIT, and ROLLBACK statements.

Updated 26 days ago

Supported SQL


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.