1 @node System and Portable File IO
2 @chapter System and Portable File I/O
4 The commands in this chapter read, write, and examine system files and
8 * APPLY DICTIONARY:: Apply system file dictionary to active dataset.
9 * EXPORT:: Write to a portable file.
10 * GET:: Read from a system file.
11 * GET DATA:: Read from foreign files.
12 * IMPORT:: Read from a portable file.
13 * SAVE:: Write to a system file.
14 * SAVE TRANSLATE:: Write data in foreign file formats.
15 * SYSFILE INFO:: Display system file dictionary.
16 * XEXPORT:: Write to a portable file, as a transformation.
17 * XSAVE:: Write to a system file, as a transformation.
20 @node APPLY DICTIONARY
21 @section APPLY DICTIONARY
22 @vindex APPLY DICTIONARY
25 APPLY DICTIONARY FROM=@{'@var{file_name}',@var{file_handle}@}.
28 @cmd{APPLY DICTIONARY} applies the variable labels, value labels,
29 and missing values taken from a file to corresponding
30 variables in the active dataset. In some cases it also updates the
33 Specify a system file or portable file's name, a data set name
34 (@pxref{Datasets}), or a file handle name (@pxref{File Handles}). The
35 dictionary in the file will be read, but it will not replace the
36 active dataset's dictionary. The file's data will not be read.
38 Only variables with names that exist in both the active dataset and the
39 system file are considered. Variables with the same name but different
40 types (numeric, string) will cause an error message. Otherwise, the
41 system file variables' attributes will replace those in their matching
42 active dataset variables:
46 If a system file variable has a variable label, then it will replace
47 the variable label of the active dataset variable. If the system
48 file variable does not have a variable label, then the active dataset
49 variable's variable label, if any, will be retained.
52 If the system file variable has custom attributes (@pxref{VARIABLE
53 ATTRIBUTE}), then those attributes replace the active dataset variable's
54 custom attributes. If the system file variable does not have custom
55 attributes, then the active dataset variable's custom attributes, if any,
59 If the active dataset variable is numeric or short string, then value
60 labels and missing values, if any, will be copied to the active dataset
61 variable. If the system file variable does not have value labels or
62 missing values, then those in the active dataset variable, if any, will not
66 In addition to properties of variables, some properties of the active
67 file dictionary as a whole are updated:
71 If the system file has custom attributes (@pxref{DATAFILE ATTRIBUTE}),
72 then those attributes replace the active dataset variable's custom
76 If the active dataset has a weighting variable (@pxref{WEIGHT}), and the
77 system file does not, or if the weighting variable in the system file
78 does not exist in the active dataset, then the active dataset weighting
79 variable, if any, is retained. Otherwise, the weighting variable in
80 the system file becomes the active dataset weighting variable.
83 @cmd{APPLY DICTIONARY} takes effect immediately. It does not read the
84 active dataset. The system file is not modified.
92 /OUTFILE='@var{file_name}'
93 /UNSELECTED=@{RETAIN,DELETE@}
97 /RENAME=(@var{src_names}=@var{target_names})@dots{}
102 The @cmd{EXPORT} procedure writes the active dataset's dictionary and
103 data to a specified portable file.
105 By default, cases excluded with FILTER are written to the
106 file. These can be excluded by specifying DELETE on the @subcmd{UNSELECTED}
107 subcommand. Specifying RETAIN makes the default explicit.
109 Portable files express real numbers in base 30. Integers are always
110 expressed to the maximum precision needed to make them exact.
111 Non-integers are, by default, expressed to the machine's maximum
112 natural precision (approximately 15 decimal digits on many machines).
113 If many numbers require this many digits, the portable file may
114 significantly increase in size. As an alternative, the @subcmd{DIGITS}
115 subcommand may be used to specify the number of decimal digits of
116 precision to write. @subcmd{DIGITS} applies only to non-integers.
118 The @subcmd{OUTFILE} subcommand, which is the only required subcommand, specifies
119 the portable file to be written as a file name string or
120 a file handle (@pxref{File Handles}).
122 @subcmd{DROP}, @subcmd{KEEP}, and @subcmd{RENAME} follow the same format as the
123 @subcmd{SAVE} procedure (@pxref{SAVE}).
125 The @subcmd{TYPE} subcommand specifies the character set for use in the
126 portable file. Its value is currently not used.
128 The @subcmd{MAP} subcommand is currently ignored.
130 @cmd{EXPORT} is a procedure. It causes the active dataset to be read.
138 /FILE=@{'@var{file_name}',@var{file_handle}@}
141 /RENAME=(@var{src_names}=@var{target_names})@dots{}
142 /ENCODING='@var{encoding}'
145 @cmd{GET} clears the current dictionary and active dataset and
146 replaces them with the dictionary and data from a specified file.
148 The @subcmd{FILE} subcommand is the only required subcommand.
150 file or portable file to be read as a string file name or
151 a file handle (@pxref{File Handles}).
153 By default, all the variables in a file are read. The DROP
154 subcommand can be used to specify a list of variables that are not to be
155 read. By contrast, the @subcmd{KEEP} subcommand can be used to specify
156 variable that are to be read, with all other variables not read.
158 Normally variables in a file retain the names that they were
159 saved under. Use the @subcmd{RENAME} subcommand to change these names.
161 within parentheses, a list of variable names followed by an equals sign
162 (@samp{=}) and the names that they should be renamed to. Multiple
163 parenthesized groups of variable names can be included on a single
164 @subcmd{RENAME} subcommand.
165 Variables' names may be swapped using a @subcmd{RENAME}
166 subcommand of the form @subcmd{/RENAME=(@var{A} @var{B}=@var{B} @var{A})}.
168 Alternate syntax for the @subcmd{RENAME} subcommand allows the parentheses to be
169 eliminated. When this is done, only a single variable may be renamed at
170 once. For instance, @subcmd{/RENAME=@var{A}=@var{B}}. This alternate syntax is
173 @subcmd{DROP}, @subcmd{KEEP}, and @subcmd{RENAME} are executed in left-to-right order.
174 Each may be present any number of times. @cmd{GET} never modifies a
175 file on disk. Only the active dataset read from the file
176 is affected by these subcommands.
178 @pspp{} tries to automatically detect the encoding of string data in the
179 file. Sometimes, however, this does not work well encoding,
180 especially for files written by old versions of SPSS or @pspp{}. Specify
181 the @subcmd{ENCODING} subcommand with an @acronym{IANA} character set name as its string
182 argument to override the default. The @subcmd{ENCODING} subcommand is a @pspp{}
185 @cmd{GET} does not cause the data to be read, only the dictionary. The data
186 is read later, when a procedure is executed.
188 Use of @cmd{GET} to read a portable file is a @pspp{} extension.
196 /TYPE=@{GNM,ODS,PSQL,TXT@}
197 @dots{}additional subcommands depending on TYPE@dots{}
200 The @cmd{GET DATA} command is used to read files and other data
201 sources created by other applications. When this command is executed,
202 the current dictionary and active dataset are replaced with variables
203 and data read from the specified source.
205 The @subcmd{TYPE} subcommand is mandatory and must be the first subcommand
206 specified. It determines the type of the file or source to read.
207 @pspp{} currently supports the following file types:
211 Spreadsheet files created by Gnumeric (@url{http://gnumeric.org}).
214 Spreadsheet files in OpenDocument format (@url{http://opendocumentformat.org}).
217 Relations from PostgreSQL databases (@url{http://postgresql.org}).
220 Textual data files in columnar and delimited formats.
223 Each supported file type has additional subcommands, explained in
224 separate sections below.
227 * GET DATA /TYPE=GNM/ODS:: Spreadsheets
228 * GET DATA /TYPE=PSQL:: Databases
229 * GET DATA /TYPE=TXT:: Delimited Text Files
232 @node GET DATA /TYPE=GNM/ODS
233 @subsection Spreadsheet Files
236 GET DATA /TYPE=@{GNM, ODS@}
237 /FILE=@{'@var{file_name}'@}
238 /SHEET=@{NAME '@var{sheet_name}', INDEX @var{n}@}
239 /CELLRANGE=@{RANGE '@var{range}', FULL@}
240 /READNAMES=@{ON, OFF@}
241 /ASSUMEDVARWIDTH=@var{n}.
246 @cindex spreadsheet files
248 Gnumeric spreadsheets (@url{http://gnumeric.org}), and spreadsheets
249 in OpenDocument format
250 (@url{http://libreplanet.org/wiki/Group:OpenDocument/Software})
251 can be read using the @cmd{GET DATA} command.
252 Use the @subcmd{TYPE} subcommand to indicate the file's format.
253 /TYPE=GNM indicates Gnumeric files,
254 /TYPE=ODS indicates OpenDocument.
255 The @subcmd{FILE} subcommand is mandatory.
256 Use it to specify the name file to be read.
257 All other subcommands are optional.
259 The format of each variable is determined by the format of the spreadsheet
260 cell containing the first datum for the variable.
261 If this cell is of string (text) format, then the width of the variable is
262 determined from the length of the string it contains, unless the
263 @subcmd{ASSUMEDVARWIDTH} subcommand is given.
265 The @subcmd{SHEET} subcommand specifies the sheet within the spreadsheet file to read.
266 There are two forms of the @subcmd{SHEET} subcommand.
268 @subcmd{/SHEET=name @var{sheet_name}}, the string @var{sheet_name} is the
269 name of the sheet to read.
270 In the second form, @subcmd{/SHEET=index @var{idx}}, @var{idx} is a
271 integer which is the index of the sheet to read.
272 The first sheet has the index 1.
273 If the @subcmd{SHEET} subcommand is omitted, then the command will read the
274 first sheet in the file.
276 The @subcmd{CELLRANGE} subcommand specifies the range of cells within the sheet to read.
277 If the subcommand is given as @subcmd{/CELLRANGE=FULL}, then the entire
279 To read only part of a sheet, use the form
280 @subcmd{/CELLRANGE=range '@var{top_left_cell}:@var{bottom_right_cell}'}.
281 For example, the subcommand @subcmd{/CELLRANGE=range 'C3:P19'} reads
282 columns C--P, and rows 3--19 inclusive.
283 If no @subcmd{CELLRANGE} subcommand is given, then the entire sheet is read.
285 If @subcmd{/READNAMES=ON} is specified, then the contents of cells of
286 the first row are used as the names of the variables in which to store
287 the data from subsequent rows. This is the default.
288 If @subcmd{/READNAMES=OFF} is
289 used, then the variables receive automatically assigned names.
291 The @subcmd{ASSUMEDVARWIDTH} subcommand specifies the maximum width of string
292 variables read from the file.
293 If omitted, the default value is determined from the length of the
294 string in the first spreadsheet cell for each variable.
297 @node GET DATA /TYPE=PSQL
298 @subsection Postgres Database Queries
302 /CONNECT=@{@var{connection info}@}
304 [/ASSUMEDVARWIDTH=@var{w}]
312 The PSQL type is used to import data from a postgres database server.
313 The server may be located locally or remotely.
314 Variables are automatically created based on the table column names
315 or the names specified in the SQL query.
316 Postgres data types of high precision, will loose precision when
317 imported into @pspp{}.
318 Not all the postgres data types are able to be represented in @pspp{}.
319 If a datum cannot be represented a warning will be issued and that
320 datum will be set to SYSMIS.
322 The @subcmd{CONNECT} subcommand is mandatory.
323 It is a string specifying the parameters of the database server from
324 which the data should be fetched.
325 The format of the string is given in the postgres manual
326 @url{http://www.postgresql.org/docs/8.0/static/libpq.html#LIBPQ-CONNECT}.
328 The @subcmd{SQL} subcommand is mandatory.
329 It must be a valid SQL string to retrieve data from the database.
331 The @subcmd{ASSUMEDVARWIDTH} subcommand specifies the maximum width of string
332 variables read from the database.
333 If omitted, the default value is determined from the length of the
334 string in the first value read for each variable.
336 The @subcmd{UNENCRYPTED} subcommand allows data to be retrieved over an insecure
338 If the connection is not encrypted, and the @subcmd{UNENCRYPTED} subcommand is
339 not given, then an error will occur.
340 Whether or not the connection is
341 encrypted depends upon the underlying psql library and the
342 capabilities of the database server.
344 The @subcmd{BSIZE} subcommand serves only to optimise the speed of data transfer.
345 It specifies an upper limit on
346 number of cases to fetch from the database at once.
347 The default value is 4096.
348 If your SQL statement fetches a large number of cases but only a small number of
349 variables, then the data transfer may be faster if you increase this value.
350 Conversely, if the number of variables is large, or if the machine on which
351 @pspp{} is running has only a
352 small amount of memory, then a smaller value will be better.
355 The following syntax is an example:
358 /CONNECT='host=example.com port=5432 dbname=product user=fred passwd=xxxx'
359 /SQL='select * from manufacturer'.
363 @node GET DATA /TYPE=TXT
364 @subsection Textual Data Files
368 /FILE=@{'@var{file_name}',@var{file_handle}@}
369 [ENCODING='@var{encoding}']
370 [/ARRANGEMENT=@{DELIMITED,FIXED@}]
371 [/FIRSTCASE=@{@var{first_case}@}]
372 [/IMPORTCASE=@{ALL,FIRST @var{max_cases},PERCENT @var{percent}@}]
373 @dots{}additional subcommands depending on ARRANGEMENT@dots{}
378 When TYPE=TXT is specified, GET DATA reads data in a delimited or
379 fixed columnar format, much like DATA LIST (@pxref{DATA LIST}).
381 The @subcmd{FILE} subcommand is mandatory. Specify the file to be read as
382 a string file name or (for textual data only) a
383 file handle (@pxref{File Handles}).
385 The @subcmd{ENCODING} subcommand specifies the character encoding of
386 the file to be read. @xref{INSERT}, for information on supported
389 The @subcmd{ARRANGEMENT} subcommand determines the file's basic format.
390 DELIMITED, the default setting, specifies that fields in the input
391 data are separated by spaces, tabs, or other user-specified
392 delimiters. FIXED specifies that fields in the input data appear at
393 particular fixed column positions within records of a case.
395 By default, cases are read from the input file starting from the first
396 line. To skip lines at the beginning of an input file, set @subcmd{FIRSTCASE}
397 to the number of the first line to read: 2 to skip the first line, 3
398 to skip the first two lines, and so on.
400 @subcmd{IMPORTCASE} can be used to limit the number of cases read from the
401 input file. With the default setting, ALL, all cases in the file are
402 read. Specify FIRST @var{max_cases} to read at most @var{max_cases} cases
403 from the file. Use @subcmd{PERCENT @var{percent}} to read only @var{percent}
404 percent, approximately, of the cases contained in the file. (The
405 percentage is approximate, because there is no way to accurately count
406 the number of cases in the file without reading the entire file. The
407 number of cases in some kinds of unusual files cannot be estimated;
408 @pspp{} will read all cases in such files.)
410 @subcmd{FIRSTCASE} and @subcmd{IMPORTCASE} may be used with delimited and fixed-format
411 data. The remaining subcommands, which apply only to one of the two file
412 arrangements, are described below.
415 * GET DATA /TYPE=TXT /ARRANGEMENT=DELIMITED::
416 * GET DATA /TYPE=TXT /ARRANGEMENT=FIXED::
419 @node GET DATA /TYPE=TXT /ARRANGEMENT=DELIMITED
420 @subsubsection Reading Delimited Data
424 /FILE=@{'@var{file_name}',@var{file_handle}@}
425 [/ARRANGEMENT=@{DELIMITED,FIXED@}]
426 [/FIRSTCASE=@{@var{first_case}@}]
427 [/IMPORTCASE=@{ALL,FIRST @var{max_cases},PERCENT @var{percent}@}]
429 /DELIMITERS="@var{delimiters}"
430 [/QUALIFIER="@var{quotes}" [/ESCAPE]]
431 [/DELCASE=@{LINE,VARIABLES @var{n_variables}@}]
432 /VARIABLES=@var{del_var1} [@var{del_var2}]@dots{}
433 where each @var{del_var} takes the form:
437 The GET DATA command with TYPE=TXT and ARRANGEMENT=DELIMITED reads
438 input data from text files in delimited format, where fields are
439 separated by a set of user-specified delimiters. Its capabilities are
440 similar to those of DATA LIST FREE (@pxref{DATA LIST FREE}), with a
443 The required @subcmd{FILE} subcommand and optional @subcmd{FIRSTCASE} and @subcmd{IMPORTCASE}
444 subcommands are described above (@pxref{GET DATA /TYPE=TXT}).
446 @subcmd{DELIMITERS}, which is required, specifies the set of characters that
447 may separate fields. Each character in the string specified on
448 @subcmd{DELIMITERS} separates one field from the next. The end of a line also
449 separates fields, regardless of @subcmd{DELIMITERS}. Two consecutive
450 delimiters in the input yield an empty field, as does a delimiter at
451 the end of a line. A space character as a delimiter is an exception:
452 consecutive spaces do not yield an empty field and neither does any
453 number of spaces at the end of a line.
455 To use a tab as a delimiter, specify @samp{\t} at the beginning of the
456 @subcmd{DELIMITERS} string. To use a backslash as a delimiter, specify
457 @samp{\\} as the first delimiter or, if a tab should also be a
458 delimiter, immediately following @samp{\t}. To read a data file in
459 which each field appears on a separate line, specify the empty string
460 for @subcmd{DELIMITERS}.
462 The optional @subcmd{QUALIFIER} subcommand names one or more characters that
463 can be used to quote values within fields in the input. A field that
464 begins with one of the specified quote characters ends at the next
465 matching quote. Intervening delimiters become part of the field,
466 instead of terminating it. The ability to specify more than one quote
467 character is a @pspp{} extension.
469 By default, a character specified on @subcmd{QUALIFIER} cannot itself be
470 embedded within a field that it quotes, because the quote character
471 always terminates the quoted field. With ESCAPE, however, a doubled
472 quote character within a quoted field inserts a single instance of the
473 quote into the field. For example, if @samp{'} is specified on
474 @subcmd{QUALIFIER}, then without ESCAPE @code{'a''b'} specifies a pair of
475 fields that contain @samp{a} and @samp{b}, but with ESCAPE it
476 specifies a single field that contains @samp{a'b}. ESCAPE is a @pspp{}
479 The @subcmd{DELCASE} subcommand controls how data may be broken across lines in
480 the data file. With LINE, the default setting, each line must contain
481 all the data for exactly one case. For additional flexibility, to
482 allow a single case to be split among lines or multiple cases to be
483 contained on a single line, specify VARIABLES @i{n_variables}, where
484 @i{n_variables} is the number of variables per case.
486 The @subcmd{VARIABLES} subcommand is required and must be the last subcommand.
487 Specify the name of each variable and its input format (@pxref{Input
488 and Output Formats}) in the order they should be read from the input
491 @subsubheading Examples
494 On a Unix-like system, the @samp{/etc/passwd} file has a format
498 root:$1$nyeSP5gD$pDq/:0:0:,,,:/root:/bin/bash
499 blp:$1$BrP/pFg4$g7OG:1000:1000:Ben Pfaff,,,:/home/blp:/bin/bash
500 john:$1$JBuq/Fioq$g4A:1001:1001:John Darrington,,,:/home/john:/bin/bash
501 jhs:$1$D3li4hPL$88X1:1002:1002:Jason Stover,,,:/home/jhs:/bin/csh
505 The following syntax reads a file in the format used by
508 @c If you change this example, change the regression test in
509 @c tests/language/data-io/get-data.at to match.
511 GET DATA /TYPE=TXT /FILE='/etc/passwd' /DELIMITERS=':'
512 /VARIABLES=username A20
522 Consider the following data on used cars:
525 model year mileage price type age
526 Civic 2002 29883 15900 Si 2
527 Civic 2003 13415 15900 EX 1
528 Civic 1992 107000 3800 n/a 12
529 Accord 2002 26613 17900 EX 1
533 The following syntax can be used to read the used car data:
535 @c If you change this example, change the regression test in
536 @c tests/language/data-io/get-data.at to match.
538 GET DATA /TYPE=TXT /FILE='cars.data' /DELIMITERS=' ' /FIRSTCASE=2
548 Consider the following information on animals in a pet store:
551 'Pet''s Name', "Age", "Color", "Date Received", "Price", "Height", "Type"
552 , (Years), , , (Dollars), ,
553 "Rover", 4.5, Brown, "12 Feb 2004", 80, '1''4"', "Dog"
554 "Charlie", , Gold, "5 Apr 2007", 12.3, "3""", "Fish"
555 "Molly", 2, Black, "12 Dec 2006", 25, '5"', "Cat"
556 "Gilly", , White, "10 Apr 2007", 10, "3""", "Guinea Pig"
560 The following syntax can be used to read the pet store data:
562 @c If you change this example, change the regression test in
563 @c tests/language/data-io/get-data.at to match.
565 GET DATA /TYPE=TXT /FILE='pets.data' /DELIMITERS=', ' /QUALIFIER='''"' /ESCAPE
576 @node GET DATA /TYPE=TXT /ARRANGEMENT=FIXED
577 @subsubsection Reading Fixed Columnar Data
579 @c (modify-syntax-entry ?_ "w")
580 @c (modify-syntax-entry ?' "'")
581 @c (modify-syntax-entry ?@ "'")
585 /FILE=@{'file_name',@var{file_handle}@}
586 [/ARRANGEMENT=@{DELIMITED,FIXED@}]
587 [/FIRSTCASE=@{@var{first_case}@}]
588 [/IMPORTCASE=@{ALL,FIRST @var{max_cases},PERCENT @var{percent}@}]
591 /VARIABLES @var{fixed_var} [@var{fixed_var}]@dots{}
592 [/rec# @var{fixed_var} [@var{fixed_var}]@dots{}]@dots{}
593 where each @var{fixed_var} takes the form:
594 @var{variable} @var{start}-@var{end} @var{format}
597 The @cmd{GET DATA} command with TYPE=TXT and ARRANGEMENT=FIXED reads input
598 data from text files in fixed format, where each field is located in
599 particular fixed column positions within records of a case. Its
600 capabilities are similar to those of DATA LIST FIXED (@pxref{DATA LIST
601 FIXED}), with a few enhancements.
603 The required @subcmd{FILE} subcommand and optional @subcmd{FIRSTCASE} and @subcmd{IMPORTCASE}
604 subcommands are described above (@pxref{GET DATA /TYPE=TXT}).
606 The optional @subcmd{FIXCASE} subcommand may be used to specify the positive
607 integer number of input lines that make up each case. The default
610 The @subcmd{VARIABLES} subcommand, which is required, specifies the positions
611 at which each variable can be found. For each variable, specify its
612 name, followed by its start and end column separated by @samp{-}
613 (e.g.@: @samp{0-9}), followed by an input format type (e.g.@:
614 @samp{F}) or a full format specification (e.g.@: @samp{DOLLAR12.2}).
615 For this command, columns are numbered starting from 0 at
616 the left column. Introduce the variables in the second and later
617 lines of a case by a slash followed by the number of the line within
618 the case, e.g.@: @samp{/2} for the second line.
620 @subsubheading Examples
623 Consider the following data on used cars:
626 model year mileage price type age
627 Civic 2002 29883 15900 Si 2
628 Civic 2003 13415 15900 EX 1
629 Civic 1992 107000 3800 n/a 12
630 Accord 2002 26613 17900 EX 1
634 The following syntax can be used to read the used car data:
636 @c If you change this example, change the regression test in
637 @c tests/language/data-io/get-data.at to match.
639 GET DATA /TYPE=TXT /FILE='cars.data' /ARRANGEMENT=FIXED /FIRSTCASE=2
640 /VARIABLES=model 0-7 A
654 /FILE='@var{file_name}'
658 /RENAME=(@var{src_names}=@var{target_names})@dots{}
661 The @cmd{IMPORT} transformation clears the active dataset dictionary and
663 replaces them with a dictionary and data from a system file or
666 The @subcmd{FILE} subcommand, which is the only required subcommand, specifies
667 the portable file to be read as a file name string or a file handle
668 (@pxref{File Handles}).
670 The @subcmd{TYPE} subcommand is currently not used.
672 @subcmd{DROP}, @subcmd{KEEP}, and @subcmd{RENAME} follow the syntax used by @cmd{GET} (@pxref{GET}).
674 @cmd{IMPORT} does not cause the data to be read; only the dictionary. The
675 data is read later, when a procedure is executed.
677 Use of @cmd{IMPORT} to read a system file is a @pspp{} extension.
685 /OUTFILE=@{'@var{file_name}',@var{file_handle}@}
686 /UNSELECTED=@{RETAIN,DELETE@}
687 /@{UNCOMPRESSED,COMPRESSED,ZCOMPRESSED@}
688 /PERMISSIONS=@{WRITEABLE,READONLY@}
691 /VERSION=@var{version}
692 /RENAME=(@var{src_names}=@var{target_names})@dots{}
697 The @cmd{SAVE} procedure causes the dictionary and data in the active
699 be written to a system file.
701 OUTFILE is the only required subcommand. Specify the system file
702 to be written as a string file name or a file handle
703 (@pxref{File Handles}).
705 By default, cases excluded with FILTER are written to the system file.
706 These can be excluded by specifying @subcmd{DELETE} on the @subcmd{UNSELECTED}
707 subcommand. Specifying @subcmd{RETAIN} makes the default explicit.
709 The @subcmd{UNCOMPRESSED}, @subcmd{COMPRESSED}, and
710 @subcmd{ZCOMPRESSED} subcommand determine the system file's
715 Data is not compressed. Each numeric value uses 8 bytes of disk
716 space. Each string value uses one byte per column width, rounded up
717 to a multiple of 8 bytes.
720 Data is compressed with a simple algorithm. Each integer numeric
721 value between @minus{}99 and 151, inclusive, or system missing value
722 uses one byte of disk space. Each 8-byte segment of a string that
723 consists only of spaces uses 1 byte. Any other numeric value or
724 8-byte string segment uses 9 bytes of disk space.
727 Data is compressed with the ``deflate'' compression algorithm
728 specified in RFC@tie{}1951 (the same algorithm used by
729 @command{gzip}). Files written with this compression level cannot be
730 read by PSPP 0.8.1 or earlier or by SPSS 20 or earlier.
733 @subcmd{COMPRESSED} is the default compression level. The SET command
734 (@pxref{SET}) can change this default.
736 The @subcmd{PERMISSIONS} subcommand specifies permissions for the new system
737 file. WRITEABLE, the default, creates the file with read and write
738 permission. READONLY creates the file for read-only access.
740 By default, all the variables in the active dataset dictionary are written
741 to the system file. The @subcmd{DROP} subcommand can be used to specify a list
742 of variables not to be written. In contrast, KEEP specifies variables
743 to be written, with all variables not specified not written.
745 Normally variables are saved to a system file under the same names they
746 have in the active dataset. Use the @subcmd{RENAME} subcommand to change these names.
747 Specify, within parentheses, a list of variable names followed by an
748 equals sign (@samp{=}) and the names that they should be renamed to.
749 Multiple parenthesized groups of variable names can be included on a
750 single @subcmd{RENAME} subcommand. Variables' names may be swapped using a
751 @subcmd{RENAME} subcommand of the
752 form @subcmd{/RENAME=(@var{A} @var{B}=@var{B} @var{A})}.
754 Alternate syntax for the @subcmd{RENAME} subcommand allows the parentheses to be
755 eliminated. When this is done, only a single variable may be renamed at
756 once. For instance, @subcmd{/RENAME=@var{A}=@var{B}}. This alternate syntax is
759 @subcmd{DROP}, @subcmd{KEEP}, and @subcmd{RENAME} are performed in
760 left-to-right order. They
761 each may be present any number of times. @cmd{SAVE} never modifies
762 the active dataset. @subcmd{DROP}, @subcmd{KEEP}, and @subcmd{RENAME} only
763 affect the system file written to disk.
765 The @subcmd{VERSION} subcommand specifies the version of the file format. Valid
766 versions are 2 and 3. The default version is 3. In version 2 system
767 files, variable names longer than 8 bytes will be truncated. The two
768 versions are otherwise identical.
770 The @subcmd{NAMES} and @subcmd{MAP} subcommands are currently ignored.
772 @cmd{SAVE} causes the data to be read. It is a procedure.
775 @section SAVE TRANSLATE
776 @vindex SAVE TRANSLATE
780 /OUTFILE=@{'@var{file_name}',@var{file_handle}@}
783 [/MISSING=@{IGNORE,RECODE@}]
785 [/DROP=@var{var_list}]
786 [/KEEP=@var{var_list}]
787 [/RENAME=(@var{src_names}=@var{target_names})@dots{}]
788 [/UNSELECTED=@{RETAIN,DELETE@}]
791 @dots{}additional subcommands depending on TYPE@dots{}
794 The @cmd{SAVE TRANSLATE} command is used to save data into various
795 formats understood by other applications.
797 The @subcmd{OUTFILE} and @subcmd{TYPE} subcommands are mandatory.
798 @subcmd{OUTFILE} specifies the file to be written, as a string file name or a file handle
799 (@pxref{File Handles}). @subcmd{TYPE} determines the type of the file or
800 source to read. It must be one of the following:
804 Comma-separated value format,
807 Tab-delimited format.
810 By default, @cmd{SAVE TRANSLATE} will not overwrite an existing file. Use
811 @subcmd{REPLACE} to force an existing file to be overwritten.
813 With MISSING=IGNORE, the default, @subcmd{SAVE TRANSLATE} treats user-missing
814 values as if they were not missing. Specify MISSING=RECODE to output
815 numeric user-missing values like system-missing values and string
816 user-missing values as all spaces.
818 By default, all the variables in the active dataset dictionary are saved
819 to the system file, but @subcmd{DROP} or @subcmd{KEEP} can select a subset of variable
820 to save. The @subcmd{RENAME} subcommand can also be used to change the names
821 under which variables are saved. @subcmd{UNSELECTED} determines whether cases
822 filtered out by the @cmd{FILTER} command are written to the output file.
823 These subcommands have the same syntax and meaning as on the
824 @cmd{SAVE} command (@pxref{SAVE}).
826 Each supported file type has additional subcommands, explained in
827 separate sections below.
829 @cmd{SAVE TRANSLATE} causes the data to be read. It is a procedure.
832 * SAVE TRANSLATE /TYPE=CSV and TYPE=TAB::
835 @node SAVE TRANSLATE /TYPE=CSV and TYPE=TAB
836 @subsection Writing Comma- and Tab-Separated Data Files
840 /OUTFILE=@{'@var{file_name}',@var{file_handle}@}
843 [/MISSING=@{IGNORE,RECODE@}]
845 [/DROP=@var{var_list}]
846 [/KEEP=@var{var_list}]
847 [/RENAME=(@var{src_names}=@var{target_names})@dots{}]
848 [/UNSELECTED=@{RETAIN,DELETE@}]
851 [/CELLS=@{VALUES,LABELS@}]
852 [/TEXTOPTIONS DELIMITER='@var{delimiter}']
853 [/TEXTOPTIONS QUALIFIER='@var{qualifier}']
854 [/TEXTOPTIONS DECIMAL=@{DOT,COMMA@}]
855 [/TEXTOPTIONS FORMAT=@{PLAIN,VARIABLE@}]
858 The SAVE TRANSLATE command with TYPE=CSV or TYPE=TAB writes data in a
859 comma- or tab-separated value format similar to that described by
860 RFC@tie{}4180. Each variable becomes one output column, and each case
861 becomes one line of output. If FIELDNAMES is specified, an additional
862 line at the top of the output file lists variable names.
864 The CELLS and TEXTOPTIONS FORMAT settings determine how values are
865 written to the output file:
868 @item CELLS=VALUES FORMAT=PLAIN (the default settings)
869 Writes variables to the output in ``plain'' formats that ignore the
870 details of variable formats. Numeric values are written as plain
871 decimal numbers with enough digits to indicate their exact values in
872 machine representation. Numeric values include @samp{e} followed by
873 an exponent if the exponent value would be less than -4 or greater
874 than 16. Dates are written in MM/DD/YYYY format and times in HH:MM:SS
875 format. WKDAY and MONTH values are written as decimal numbers.
877 Numeric values use, by default, the decimal point character set with
878 SET DECIMAL (@pxref{SET DECIMAL}). Use DECIMAL=DOT or DECIMAL=COMMA
879 to force a particular decimal point character.
881 @item CELLS=VALUES FORMAT=VARIABLE
882 Writes variables using their print formats. Leading and trailing
883 spaces are removed from numeric values, and trailing spaces are
884 removed from string values.
886 @item CELLS=LABEL FORMAT=PLAIN
887 @itemx CELLS=LABEL FORMAT=VARIABLE
888 Writes value labels where they exist, and otherwise writes the values
889 themselves as described above.
892 Regardless of CELLS and TEXTOPTIONS FORMAT, numeric system-missing
893 values are output as a single space.
895 For TYPE=TAB, tab characters delimit values. For TYPE=CSV, the
896 TEXTOPTIONS DELIMITER and DECIMAL settings determine the character
897 that separate values within a line. If DELIMITER is specified, then
898 the specified string separate values. If DELIMITER is not specified,
899 then the default is a comma with DECIMAL=DOT or a semicolon with
900 DECIMAL=COMMA. If DECIMAL is not given either, it is implied by the
901 decimal point character set with SET DECIMAL (@pxref{SET DECIMAL}).
903 The TEXTOPTIONS QUALIFIER setting specifies a character that is output
904 before and after a value that contains the delimiter character or the
905 qualifier character. The default is a double quote (@samp{"}). A
906 qualifier character that appears within a value is doubled.
909 @section SYSFILE INFO
913 SYSFILE INFO FILE='@var{file_name}'.
916 @cmd{SYSFILE INFO} reads the dictionary in a system file and
917 displays the information in its dictionary.
919 Specify a file name or file handle. @cmd{SYSFILE INFO} reads that file as
920 a system file and displays information on its dictionary.
922 @cmd{SYSFILE INFO} does not affect the current active dataset.
930 /OUTFILE='@var{file_name}'
934 /RENAME=(@var{src_names}=@var{target_names})@dots{}
939 The @cmd{EXPORT} transformation writes the active dataset dictionary and
940 data to a specified portable file.
942 This transformation is a @pspp{} extension.
944 It is similar to the @cmd{EXPORT} procedure, with two differences:
948 @cmd{XEXPORT} is a transformation, not a procedure. It is executed when
949 the data is read by a procedure or procedure-like command.
952 @cmd{XEXPORT} does not support the @subcmd{UNSELECTED} subcommand.
955 @xref{EXPORT}, for more information.
963 /OUTFILE='@var{file_name}'
964 /@{UNCOMPRESSED,COMPRESSED,ZCOMPRESSED@}
965 /PERMISSIONS=@{WRITEABLE,READONLY@}
968 /VERSION=@var{version}
969 /RENAME=(@var{src_names}=@var{target_names})@dots{}
974 The @cmd{XSAVE} transformation writes the active dataset's dictionary and
975 data to a system file. It is similar to the @cmd{SAVE}
976 procedure, with two differences:
980 @cmd{XSAVE} is a transformation, not a procedure. It is executed when
981 the data is read by a procedure or procedure-like command.
984 @cmd{XSAVE} does not support the @subcmd{UNSELECTED} subcommand.
987 @xref{SAVE}, for more information.