From 8ec57cc6b731fb54dccd855f557a6d5bdbfed053 Mon Sep 17 00:00:00 2001 From: ckunki Date: Sun, 22 Feb 2026 14:50:53 +0100 Subject: [PATCH 1/5] #145: Described SaaS instance naming conventions in the User Guide --- doc/changes/unreleased.md | 8 ++++++++ doc/user_guide/user-guide.md | 21 +++++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md index 79e701b8..a5481c81 100644 --- a/doc/changes/unreleased.md +++ b/doc/changes/unreleased.md @@ -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 diff --git a/doc/user_guide/user-guide.md b/doc/user_guide/user-guide.md index d721f232..c9717334 100644 --- a/doc/user_guide/user-guide.md +++ b/doc/user_guide/user-guide.md @@ -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: <time><random><pst>`-`<user> + +* <time> 5 characters hex `0-9a-f` encoding the minutes since new year UTC. +* <random> 5 random hex characters `0-9a-f` to avoid duplicate names. +* <pst> optional project short tag, truncated to not exceed the maximum name length. +* <user> name of the current user. On GitHub runners typically "runner", also truncated. + +Example: `10aa5dd99cSAPIPY-run`, was generated from +* <time> `10aa5`hex = `68261`dec minutes since new year = February, 17 09:41 +* <random> `dd99c` +* <pst> `SAPIPY` +* <user> `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. From cb0e8e229543e498406d37ba792bb1889f0b5873 Mon Sep 17 00:00:00 2001 From: ckunki Date: Mon, 23 Feb 2026 08:04:28 +0100 Subject: [PATCH 2/5] Added CSS --- doc/user_guide/user-guide.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/user_guide/user-guide.md b/doc/user_guide/user-guide.md index c9717334..1543440b 100644 --- a/doc/user_guide/user-guide.md +++ b/doc/user_guide/user-guide.md @@ -1,3 +1,9 @@ + # SaaS API for Python User Guide ## Naming SaaS instances From eb6550a3c4ea87980d40245c0feb3816476a70a9 Mon Sep 17 00:00:00 2001 From: ckunki Date: Mon, 23 Feb 2026 08:05:18 +0100 Subject: [PATCH 3/5] typo --- doc/user_guide/user-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user_guide/user-guide.md b/doc/user_guide/user-guide.md index 1543440b..43e3e14e 100644 --- a/doc/user_guide/user-guide.md +++ b/doc/user_guide/user-guide.md @@ -10,7 +10,7 @@ var { 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. +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. From b0e56e407d83f1eee247fabe132cb7e7703891ac Mon Sep 17 00:00:00 2001 From: ckunki Date: Mon, 23 Feb 2026 10:41:55 +0100 Subject: [PATCH 4/5] Wrapped CSS into HTML comment --- doc/user_guide/user-guide.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/user_guide/user-guide.md b/doc/user_guide/user-guide.md index 43e3e14e..c7680704 100644 --- a/doc/user_guide/user-guide.md +++ b/doc/user_guide/user-guide.md @@ -1,9 +1,12 @@ + + # SaaS API for Python User Guide ## Naming SaaS instances From 489b2162da7aea36f4802f4a69ffc3a08785f19c Mon Sep 17 00:00:00 2001 From: ckunki Date: Mon, 23 Feb 2026 10:45:32 +0100 Subject: [PATCH 5/5] Removed CSS --- doc/user_guide/user-guide.md | 9 --------- 1 file changed, 9 deletions(-) diff --git a/doc/user_guide/user-guide.md b/doc/user_guide/user-guide.md index c7680704..25c98789 100644 --- a/doc/user_guide/user-guide.md +++ b/doc/user_guide/user-guide.md @@ -1,12 +1,3 @@ - - # SaaS API for Python User Guide ## Naming SaaS instances