Syntax
Table of Contents
The Katzebase SQL dialect (KBSQL) is very similar to T-SQL. Statements do not need to be separated by semicolons or any other terminator; a script can simply list one statement after another. Statements are used to create and alter schemas and indexes; to insert, read, update and delete documents; to manage accounts and permissions; and to run system procedures.
The statements fall into two groups: (1) DML, or data manipulation language, for selecting, inserting, updating and deleting documents, and (2) DDL, or data definition language, for objects such as schemas, indexes, accounts and roles. See DML Glossary and DDL Glossary.
Sample data
The examples use the WordList sample database (see the home page) and the built-in Single schema.A schema is a container of documents, indexes and other schemas. Schemas are nested and their names are separated with colons, for example WordList:Word is the Word schema inside the WordList schema. A document is a set of field/value pairs. Documents in the same schema do not need to have the same fields.
- Keywords, schema names, field names and function names are not case-sensitive.
- String comparisons with =, != and LIKE are not case-sensitive.
- Strings are enclosed in single (or double) quotes.
- Comments start with -- (until the end of the line) or are enclosed in /* and */.
See Expressions for literals, operators and variables.
SELECT * FROM WordList:WordSELECT
Id, Text, LanguageId
FROM
WordList:Word
WHERE
Text = 'Dog'INSERT INTO WordList:Word (Id, Text, LanguageId)
VALUES (1000, 'Sarah', 1), (1001, 'Brightman', 1)INSERT INTO WordList:Word
(Id: 1002, Text: 'Neward', LanguageId: 1),
(Id: 1003, Text: 'Katzebase')UPDATE
WordList:Word
SET
Text = 'Newark',
LanguageId = 2
WHERE
Id = 1002DELETE FROM
WordList:Word
WHERE
Text = 'Newark'CREATE SCHEMA WordList:DefinitionsDROP SCHEMA WordList:DefinitionsCREATE INDEX IX_Word_LanguageId_Text
(
LanguageId,
Text
) ON WordList:WordDROP INDEX IX_Word_LanguageId_Text ON WordList:WordEXEC ShowProcessesAPI :: Client
Using the NTDLS.Katzebase.Api client library from .NET.
Home
The home page
SQL :: Abs
Returns the absolute value of a number.
SQL :: Aggregate Functions
Aggregate functions compute one value from a group of rows.
SQL :: Alter Procedure
User-defined stored procedures are not currently available.
SQL :: Avg
Returns the average (arithmetic mean) of the values in each group.
SQL :: Cancel
Cancels (rolls back) the transaction of the given process, leaving the process connected.
SQL :: Ceil
Returns the smallest whole number that is greater than or equal to the given number.
SQL :: CheckpointHealthCounters
Writes the health counters to disk. This is useful when monitoring performance and you need the metrics in the health JSON file.
SQL :: Checksum
Returns a simple 16-bit checksum (0 to 65535) of the value's ASCII bytes. It is fast but not collision resistant; use Sha256 when the value must be unique.