gm-import_incoming(1)

πŸ’– gm-import_incoming β€” the manual page, bestie edition πŸ’–

okay so this is gm-import_incoming, and it lives in the General Commands Manual (section 1, obvs). it's giving "tiny script, huge responsibility" energy. let's get into it. ✨


🌸 NAME 🌸

gm-import_incoming β€” a script to import a file into the INCOMING area of a GNUmed database. that's it. that's the whole job. and she does it flawlessly. πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

gm-import_incoming [-h|?] [--help] [--local-import] --file2import=FILE
--data-type=TYPE --user=USER [--host=HOST] [--port=PORT]

like, look at her. some of these are required, some are optional, and she will absolutely tell you which is which. 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

gm-import_incoming is a script for importing a file into the GNUmed database area where incoming files are stored which have not been linked to any patient. so it's the waiting room. the holding pen. the "we'll deal with you later, babe" folder. 😌

a type gets associated with the data so it's easier to recognise later. lowkey essential.

this script can be used to import, for later processing: fax images, lab data, referral letters, and similar data which electronically arrives on your system. so basically anything that shows up in your inbox going "hi i'm a document and i need a home". iconic behaviour honestly. πŸ”₯


✨ OPTIONS ✨

  • --help, -h, -? β€” shows a help screen. the classic. she's helpful AND polite. πŸ’–
  • --local-import β€” at startup, this adjusts the PYTHONPATH such that the GNUmed client is run from a local copy of the source tree (say, an unpacked tarball) rather than from a proper system-wide installation. so like, running from your lil sandbox instead of the real thing. no cap. 🧚
  • --file2import=FILE β€” this is the file to be imported into GNUmed.

successfully imported files are renamed to FILE.imported within the directory in which FILE resides. so after the glow-up she gets a lil .imported suffix, periodt. πŸ’…

  • --data-type=TYPE β€” a short moniker, say, a word or two, used to describe the data in FILE to the user when viewed inside GNUmed.

the actual content of TYPE is only limited by the execution environment (locale, encoding, ...) of gm-import_incoming. GNUmed does not need to understand what TYPE means to the user. so go off, name it whatever, she's not gonna judge. 🌈

  • --user=USER β€” the PostgreSQL user to be used for connecting to the database.
bestie, listen. this must currently be a GNUmed staff account. it will also work with the cluster superuser (usually "postgres") or the GNUmed database owner (typically "gm-dbo") β€” but using these in production is strongly discouraged for data security reasons. like, do not. i'm serious. πŸ™ˆ
  • --host=HOST β€” the hostname of the machine PostgreSQL is running on, if required.

if this option is not used (or set to an empty string) it will default to connecting over UNIX domain sockets. the vibes will simply handle it. πŸ“

  • --port=PORT β€” the port PostgreSQL is listening on. default PostgreSQL installations listen on port 5432. remember that number, it comes up at parties. πŸ’€

there are no options for database name or password. none. don't go looking. πŸ‘‘

the script uses the default database name of the GNUmed version the script is released with, thereby assuring data does not get imported into an older database following an upgrade. she's self-aware, she knows what version she is, main character energy fr fr. ⭐

if a password is needed (that is, if TRUST, IDENT, or PEER authentication is not in use) it must be supplied by either setting the $PGPASSFILE environment variable or using a standard ~/.pgpass file. those are the only two doors. pick one. πŸšͺ


πŸ’œ ENVIRONMENT πŸ’œ

  • PGPASSFILE

http://www.postgresql.org/docs/devel/static/libpq-pgpass.html


🌸 FILES 🌸

  • ~/.pgpass

http://www.postgresql.org/docs/devel/static/libpq-pgpass.html


🌈 SEE ALSO 🌈

  • http://wiki.gnumed.de β€” detailed Wiki-style documentation. iykyk. πŸ“š
  • /usr/share/doc/gnumed/ β€” local documentation. right there on your machine, living her life. πŸ’–
  • man -k gm-* β€” list man pages on gm-* commands. the ultimate "who else is in this family" moment. πŸ‘‘

and that's the whole page, bestie!! this one is from gm-import_incoming, dated 2016 April 19th, and she's been slaying in section 1 of the General Commands Manual ever since. go import something. πŸŽ€βœ¨πŸ¦‹