Skip to content

#145: Described SaaS instance naming conventions in the User Guide #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ckunki merged 5 commits into from
Feb 23, 2026
Merged

#145: Described SaaS instance naming conventions in the User Guide #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8ec57cc
#145: Described SaaS instance naming conventions in the User Guide
ckunki Feb 22, 2026
cb0e8e2
Added CSS
ckunki Feb 23, 2026
eb6550a
typo
ckunki Feb 23, 2026
b0e56e4
Wrapped CSS into HTML comment
ckunki Feb 23, 2026
489b216
Removed CSS
ckunki Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/changes/unreleased.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# Unreleased

## Summary

This release describes naming conventions for SaaS instances in the User Guide.

## Documentation

* #145: Described SaaS instance naming conventions in the User Guide
21 changes: 21 additions & 0 deletions doc/user_guide/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,26 @@
# SaaS API for Python User Guide

## Naming SaaS instances

SAPIPY offers function `timestamp_name()` to name database instances.

In case of left-over SaaS instances, the generated name is intended to identify who created the database, when, and for which project.

Exasol SaaS limits database names to max 20 characters.

SAPIPY function `timestamp_name()` uses the following format: <var>&lt;time>&lt;random>&lt;pst>`-`&lt;user></var>

* <var>&lt;time></var> 5 characters hex `0-9a-f` encoding the minutes since new year UTC.
* <var>&lt;random></var> 5 random hex characters `0-9a-f` to avoid duplicate names.
* <var>&lt;pst></var> optional project short tag, truncated to not exceed the maximum name length.
* <var>&lt;user></var> name of the current user. On GitHub runners typically "runner", also truncated.

Example: `10aa5dd99cSAPIPY-run`, was generated from
* <var>&lt;time></var> `10aa5`<sub>hex</sub> = `68261`<sub>dec</sub> minutes since new year = February, 17 09:41
* <var>&lt;random></var> `dd99c`
* <var>&lt;pst></var> `SAPIPY`
* <var>&lt;user></var> `run`, probably truncated from `runner`

## Raise Error on Response Status Code Other Than 200

The default behavior of the API client is to return a response with a status code and optionally an attribute `parsed` containing the returned data.
Expand Down