Fsdb::F...ilealter(3)

📦
version 3.9 · 3 versions
, in epel 9

💖 NAME 💖

Okay bestie, meet dbfilealter — the Fsdb glow-up tool that alters the format of an Fsdb file by changing the row/column separator. This page is Fsdb::F...ilealter(3) from the Perl user-contributed docs, and it is literally giving "make my separators make sense" energy 💅✨

dbfilealter — alter the format of an Fsdb file, changing the row/column separator.

✨ SYNOPSIS ✨

dbfilealter [-c] [-F fs] [-R rs] [-Z compression] [column...]

🦋 DESCRIPTION 🦋

Okay so this program reformats a Fsdb file, altering the row separator (-R rs) or the column separator (-F fs). It verifies that this action does not violate the file constraints — for example, if spaces appear in data and the new format has space as a separator — and it can optionally correct things. ✨

With -Z compression it controls compression on the file. 🫶

🎀 OPTIONS 🎀

  • -F, --fs, --fieldseparator S — specify the field (column) separator as S. See below for valid field separators. 🌸
  • -R, --rs, --rowseparator S — specify the row separator as S. See below for valid row separators. 🌈
  • -Z, --compression S — specify file compression as given by file extension S. Supported compressions are gz for gzip, bz2 for bzip2, xz for xz, or none or undef to disable compression. Default is none. 💜
  • -c, --correct — correct any inconsistency caused by the new separators, if possible. 🛠️

This module also supports the standard fsdb options, no cap:

  • -d — enable debugging output. 🐞
  • -i, --input InputSource — read from InputSource, typically a file name, or - for standard input, or (if in Perl) a IO::Handle, Fsdb::IO or Fsdb::BoundedQueue objects. 📥
  • -o, --output OutputDestination — write to OutputDestination, typically a file name, or - for standard output, or (if in Perl) a IO::Handle, Fsdb::IO or Fsdb::BoundedQueue objects. 📤
  • --autorun, --noautorun — by default, programs process automatically, but Fsdb::Filter objects in Perl do not run until you invoke the run() method. The --(no)autorun option controls that behavior within Perl. 🤖
  • --help — show help. 🆘
  • --man — show full manual. 📖

🌟 Valid Field Separators 🌟

  • D — default: any amount of whitespace on input, tabs on output. ✨
  • s — single space (exactly one space for input and output). 🫧
  • S — double space on output; two or more spaces on input. 💫
  • t — single tab character (exactly one tab for input and output). 🎯
  • XN — take N as one or more hex digits that specify a unicode character. Accept one or more of those characters on input, output exactly one of those characters. 🔥
  • CA — take A as a one (unicode) literal character. Accept one or more of those characters on input, output exactly one of those characters. 🌸

Potentially in the future xN and cA will support single-character-on-input equivalents of XN and <CA>. 👀

🌈 Valid Row Seperators 🌈

Three row separators are allowed, bestie:

  • D — the default, one line per row. ⭐
  • C — complete rowized. Each line is a field-labeled and its value, and a blank line separates "rows". All fields present in the output. 👑
  • I — incompletely rowized. Like C, but null fields are omitted from the output. 🍓

🍓 SAMPLE USAGE 🍓

Input:

#fsdb name id test1
a 1 80
b 2 70
c 3 65

Command:

cat data.fsdb | dbfilealter -F S

Output:

#fsdb -F S name id test1
a  1  80
b  2  70
c  3  65
#  | dbfilealter -F S

Command 2:

cat data.fsdb | dbfilealter -R C

Output:

#fsdb -R C name id test1
name: a
id: 1
test1: 80

name: b
id: 2
test1: 70

name: c
id: 3
test1: 65

#   | dbfilealter -R C

Correction mode input:

#fsdb -F S name id test1
a student  1  80
b nice  2  70
c all  3  65

Correction mode command:

cat correction.fsdb | dbfilealter -c -F D

Correction mode output:

#fsdb name id test1
a_student   1       80
b_nice      2       70
c_all       3       65
#   | dbfilealter -c -F D

🦋 SEE ALSO 🦋

Fsdb, dbcoldefine.

👑 CLASS FUNCTIONS 👑

🎀 new 🎀

$filter = new Fsdb::Filter::dbfilealter(@arguments);

Create a new dbfilealter object, taking command-line arguments. ✨

🌸 set_defaults 🌸

$filter->set_defaults();

Internal: set up defaults.

🦋 parse_options 🦋

$filter->parse_options(@ARGV);

Internal: parse command-line arguments.

⭐ setup ⭐

$filter->setup();

Internal: setup, parse headers.

💫 run 💫

$filter->run();

Internal: run over each rows.

Copyright (C) 2008-2018 by John Heidemann <johnh@isi.edu> 🫶

This program is distributed under terms of the GNU general public license, version 2. See the file COPYING with the distribution for details. 📜

Sign-off tea ☕: this page is from perl v5.32.1, dated 2024-08-02, and it lives at Fsdb::F...ilealter(3). Bye bestie, go slay those separators 💅✨

📦 where this page comes from