shisa_cfg_db(3)

📦
version 1.0.3 · 2 versions
  • 1.0.3 · debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 1.0.2 · ubuntu jammy
, in debian bookworm, debian trixie, nixos 26.05, nixpkgs unstable, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 shisa_cfg_db — a whole function, in the shishi manual, section 3 (library calls) 💖

okay bestie, sit down, hydrate, and let's talk about shisa_cfg_db. it's an API function from the shishi library, and honestly? it's giving "let me set up your database real quick." ✨

🌸 NAME 🌸

shisa_cfg_db — it's an API function, bestie. that's the whole name. no notes. 💅

✨ SYNOPSIS ✨

#include <shisa.h>

int shisa_cfg_db(Shisa * dbh, const char * value);

like. two args. very demure, very mindful. 🎀

🫶 ARGUMENTS 🫶

  • Shisa * dbh — the Shisa library handle, and you get it from shisa(). it's literally your library bestie. you need it before you can do anything. 👑
  • const char * value — a string holding your database definition. that's it. that's the string. it's the whole vibe of the database you're about to open. 💜

🦋 DESCRIPTION 🦋

so what does it do? it sets up and opens a new database. slay. 🔥

the syntax of that value parameter is:

"TYPE[ LOCATION[ PARAMETER]]"

where TYPE is one of the supported database types — typically "file". okay so TYPE is the main character here, LOCATION and PARAMETER are optional supporting cast. 🌈

those two substrings, LOCATION and PARAMETER, are optional strings, and they get passed on verbatim to the database during initialization. no editing, no filtering, no glow-up. they go in exactly as you wrote them. 💖

⚠️ important though, bestie: neither TYPE nor LOCATION may contain embedded spaces. like, spaces are NOT invited to that party. but PARAMETER may contain spaces, because PARAMETER is built different. 🫶

⭐ RETURN VALUE ⭐

returns SHISA_OK if a database was parsed and opened successfully. that's the good ending. 🎀

😭 REPORTING BUGS 😭

found a bug? do NOT suffer in silence, babe. report bugs to <bug-shishi@gnu.org>. 💌

Copyright © 2002-2022 Simon Josefsson.

copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. so yes, you can share it, just keep the receipts. 💅

💀 SEE ALSO 💀

the full documentation for shishi is maintained as a Texinfo manual. if the info and shishi programs are properly installed at your site, the command

info shishi

should give you access to the complete manual. go read it, i promise it's worth it. 🧚

and that's the whole page, bestie!! 🌸 this one's from shishi 1.0.3, and it's shisa_cfg_db(3) — the section 3 library-call girlies. mwah, love u, go open a database. 💖✨🎀

📦 where this page comes from