ADAFIN (File Information Report)

#### Search Results

Search

# ADAFIN (File Information Report)

This document describes the utility "ADAFIN".

The following topics are covered:

- Functional Overview

- Procedure Flow

- Checkpoints

- Control Parameters

## Functional Overview

The file information utility ADAFIN displays

- the FDT,

- descriptor information, and

- the number of blocks in the Data Storage, Normal Index or Upper Index and their usage

of one or more selected files.

This utility is a multi-function utility. For more information about single- and multi-function utilities, please see Adabas Basics > Using Utilities > Single- and Multi-function utility in the Adabas on Windows and for Linux and Cloud documentation.

## Procedure Flow

Data Set | Environment Variable/ Logical Name | Storage Medium | Additional Information
--- | --- | --- | ---
Associator | ASSOx | Disk |
Data storage | DATAx | Disk |
Control statements | stdin/ SYS$INPUT |  | Utilities Manual
ADAFIN messages | stdout/ SYS$OUTPUT |  | Messages and Codes
Work | WORK1 | Disk |

## Checkpoints

The utility writes no checkpoints.

## Control Parameters

The following control parameters are available:

         ADAM_DS = keyword

    M    DBID = number

         DESCRIPTOR = { = | : }{ * | (string [,string]...)  }

         FDT

    M    FILE = { * | (number [-number] [,number [-number]]...)  }

    D    [NO]HISTOGRAM

         USAGE = (keyword [,keyword [,keyword]])

### ADAM_DS

    ADAM_DS = keyword

This parameter can be used in conjunction with USAGE=DS for ADAM files. It selects the data section of the ADAM file for which information is to be displayed. The following keywords can be used:

Keyword | Meaning
--- | ---
FULL | All of the DS space is selected
ADAM | Only the ADAM area is selected
OVERFLOW | Only the ADAM overflow area is selected

### DBID

    DBID = number

This parameter selects the database to be used.

### DESCRIPTOR

    DESCRIPTOR = { = | : }{ * | (string [,string]...) }

This function defines the list of descriptors for which information is to be displayed. If more than one file is selected, information may only be requested for all descriptors (DESCRIPTOR = *).

The DESCRIPTOR function can only be executed if the selected files are not opened for update with the nucleus running. This function can only be selected in conjunction with the FILE parameter.

The DESCRIPTOR function does not synchronize against parallel updates (for example ADAINV REINVERT).

#### Examples

    adafin: file=13, descriptor=ca

    Database 76, File    13  (MISCELLANEOUS   )          27-OCT-2006 08:08:17

    Descriptor CA , Format: A , Options: NU

                                 min         max          ave
    ---------------------------------------------------------
    Length                         1         233        20.59
    ISNs per value                 1           2         1.08

    Values:       different:         86     total:         93
    ASSO-Blocks:         NI:          2        UI:          1

    adafin: file=(11,12), descriptor=*
    Database 1, File    11  (EMPLOYEES-NAT   )          27-OCT-2006 08:09:39

    Descriptor AA , Format: A , Options: UQ

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              8                8               8.00
    ISNs per value                      1                1               1.00

    Values:       different:              1,107     total:              1,107
    ASSO-Blocks:         NI:                  5        UI:                  1

    Descriptor AE , Format: A , Options: None

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              3               17               6.78
    ISNs per value                      1               19               1.37

    Values:       different:                804     total:              1,107
    ASSO-Blocks:         NI:                  4        UI:                  1

    Descriptor AH , Format: P , Options: NC

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              4                4               4.00
    ISNs per value                      1               43               1.20

    Values:       different:                921     total:              1,107
    ASSO-Blocks:         NI:                  4        UI:                  1

    Descriptor AJ , Format: A , Options: NU

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              3               20               8.52
    ISNs per value                      1              141               3.60

    Values:       different:                307     total:              1,107
    ASSO-Blocks:         NI:                  3        UI:                  1

    Descriptor AO , Format: A , Options: None

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              6                6               6.00
    ISNs per value                      1               99               6.62

    Values:       different:                167     total:              1,107
    ASSO-Blocks:         NI:                  2        UI:                  1

    Descriptor AP , Format: A , Options: NU

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              2               25              12.56
    ISNs per value                      1               75               4.67

    Values:       different:                237     total:              1,107
    ASSO-Blocks:         NI:                  3        UI:                  1

    Descriptor AZ , Format: A , Options: NU,MU

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              3                3               3.00
    ISNs per value                      1              843              86.28

    Values:       different:                 21     total:              1,812
    ASSO-Blocks:         NI:                  2        UI:                  1

    Super-Descriptor H1 , Format: B , Options: NU
    Parent field(s):            AU  (  1 -   2) U
                                AV  (  1 -   2) U

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              4                4               4.00
    ISNs per value                      1               93               4.17

    Values:       different:                259     total:              1,081
    ASSO-Blocks:         NI:                  2        UI:                  1

    Phonetic-Descriptor PH , Format: A , Options: None
    Parent field(s):            AE              A

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              3                3               3.00
    ISNs per value                      1               33               1.82

    Values:       different:                608     total:              1,107
    ASSO-Blocks:         NI:                  3        UI:                  1

    Sub-Descriptor S1 , Format: A , Options: None
    Parent field(s):            AO  (  1 -   4) A

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              4                4               4.00
    ISNs per value                      1              208              85.15

    Values:       different:                 13     total:              1,107
    ASSO-Blocks:         NI:                  2        UI:                  1

    Super-Descriptor S2 , Format: A , Options: None
    Parent field(s):            AO  (  1 -   6) A
                                AE  (  1 -  20) A

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              9               23              12.78
    ISNs per value                      1                5               1.05

    Values:       different:              1,052     total:              1,107
    ASSO-Blocks:         NI:                  6        UI:                  1

    Super-Descriptor S3 , Format: A , Options: NU,PE
    Parent field(s):            AR  (  1 -   3) A
                                AS  (  1 -   9) P

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                             12               12              12.00
    ISNs per value                      1               25               2.15

    Values:       different:              1,567     total:              3,383
    ASSO-Blocks:         NI:                 10        UI:                  1

    Highest PE-occurrence:          5

    Database 1, File    12  (VEHICLES        )          10-OCT-2006 14:30:39

    Descriptor AA , Format: A , Options: UQ,NU

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              6               10               7.91
    ISNs per value                      1                1               1.00

    Values:       different:                772     total:                772
    ASSO-Blocks:         NI:                  4        UI:                  1

    Descriptor AC , Format: A , Options: None

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              1                8               7.74
    ISNs per value                      1               24               1.16

    Values:       different:                662     total:                773
    ASSO-Blocks:         NI:                  3        UI:                  1

    Descriptor AD , Format: A , Options: NU

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              2               14               6.63
    ISNs per value                      1              179              17.17

    Values:       different:                 45     total:                773
    ASSO-Blocks:         NI:                  1        UI:                  1

    Descriptor AF , Format: A , Options: NU

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              3               10               4.95
    ISNs per value                      1              135              11.36

    Values:       different:                 68     total:                773
    ASSO-Blocks:         NI:                  1        UI:                  1

    Descriptor AH , Format: A , Options: FI

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              1                1               1.00
    ISNs per value                    169              329             257.66

    Values:       different:                  3     total:                773
    ASSO-Blocks:         NI:                  1        UI:                  1

    Super-Descriptor AO , Format: A , Options: NU
    Parent field(s):            AG  (  1 -   2) U
                                AD  (  1 -  20) A

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              4               16               8.63
    ISNs per value                      1               45               4.29

    Values:       different:                180     total:                773
    ASSO-Blocks:         NI:                  2        UI:                  1

    Total of 18 descriptors

Information about all descriptors in the specified files is displayed.

### FDT

    FDT

This parameter displays the Field Definition Tables (FDTs) of the files selected with the FILE parameter. This function can only be selected in conjunction with the FILE parameter.

#### Example

    adafin: file=9, fdt
    Database 1, File     9  (EMPLOYEES       )          27-OCT-2006 08:11:42

    Field Definition Table:

       Level  I Name I Length I Format I   Options         I Flags   I Encoding
    -------------------------------------------------------------------------------
      1       I  AA  I    8   I    A   I DE,UQ             I         I
      1       I  AB  I        I        I                   I         I
       2      I  AC  I   20   I    W   I NU                I         I
       2      I  AE  I   20   I    W   I NU                I SP      I
       2      I  AD  I   20   I    W   I NU                I         I
      1       I  AF  I    1   I    A   I FI                I         I
      1       I  AG  I    1   I    A   I FI                I         I
      1       I  AH  I    8   I    U   I DE                I         I
      1       I  A1  I        I        I                   I         I
       2      I  AI  I   20   I    W   I NU,MU             I         I
       2      I  AJ  I   20   I    W   I DE,NU             I         I
       2      I  AK  I   10   I    A   I NU                I         I
       2      I  AL  I    3   I    A   I NU                I         I
      1       I  A2  I        I        I                   I         I
       2      I  AN  I    6   I    A   I NU                I         I
       2      I  AM  I   15   I    A   I NU                I         I
      1       I  AO  I    6   I    A   I DE                I SB,SP   I
      1       I  AP  I   25   I    W   I DE,NU             I         I
      1       I  AQ  I        I        I PE                I         I
       2      I  AR  I    3   I    A   I NU                I SP      I
       2      I  AS  I    5   I    P   I NU                I SP      I
       2      I  AT  I    5   I    P   I NU,MU             I         I
      1       I  A3  I        I        I                   I         I
       2      I  AU  I    2   I    U   I                   I SP      I
       2      I  AV  I    2   I    U   I NU                I SP      I
      1       I  AW  I        I        I PE                I         I
       2      I  AX  I    8   I    U   I NU                I         I
       2      I  AY  I    8   I    U   I NU                I         I
      1       I  AZ  I    3   I    A   I DE,NU,MU          I         I
    -------------------------------------------------------------------------------
       Type   I Name I Length I Format I   Options         I Parent field(s)   Fmt
    -------------------------------------------------------------------------------
     COLL     I  CN  I1,144   I        I NU,HE             I AE  de__PHONEBOOK
              I      I        I        I                   I     PRIMARY
    -------------------------------------------------------------------------------
     SUPER    I  H1  I    4   I    B   I NU                I AU (   1 -   2 )   U
              I      I        I        I                   I AV (   1 -   2 )   U
    -------------------------------------------------------------------------------
     SUB      I  S1  I    4   I    A   I                   I AO (   1 -   4 )   A
    -------------------------------------------------------------------------------
     SUPER    I  S2  I   26   I    A   I NU                I AO (   1 -   6 )   A
              I      I        I        I                   I AE (   1 -  20 )   W
    -------------------------------------------------------------------------------
     SUPER    I  S3  I   12   I    A   I NU,PE             I AR (   1 -   3 )   A
              I      I        I        I                   I AS (   1 -   9 )   P
    -------------------------------------------------------------------------------

### FILE

    FILE = { * | (number [-number] [,number [-number]]...) }

This parameter selects one or more files from a database and displays information about these files in accordance with the following parameter. Specifying FILE = * selects all files.

### [NO]HISTOGRAM

    [NO]HISTOGRAM

If the HISTOGRAM option is selected, a graphical overview of the descriptor-value length distributions will be provided in all the information that is subsequently displayed by the DESCRIPTOR function.

If HISTOGRAM is used, it must be specified before the DESCRIPTOR parameter.

Using the HISTOGRAM option does not lead to additional I/Os on the data sets.

The default is NOHISTOGRAM.

#### Example (with HISTOGRAM)

    adafin: file=9, histogram, descriptor=ap
    Database 1, File     9  (EMPLOYEES       )          27-OCT-2006 08:12:44

    Descriptor AP , Format: W , Options: NU

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              2               26              12.71
    ISNs per value                      1               75               4.61

    Values:       different:                240     total:              1,107
    ASSO-Blocks:         NI:                  3        UI:                  1

    Histogram of descriptor value length for descriptor AP

    Length |             25%            50%            75%          100%| Frequency
    -------+--------------+--------------+--------------+---------------+----------
       2   |*                                                           |         1
       3   |*                                                           |        22
       5   |*                                                           |         7
       6   |*                                                           |        26
       7   |******                                                      |       124
       8   |****                                                        |        83
       9   |******                                                      |       117
      10   |******                                                      |       119
      11   |***                                                         |        67
      12   |****                                                        |        83
      13   |*                                                           |        23
      14   |**                                                          |        47
      15   |**                                                          |        46
      16   |**                                                          |        46
      17   |*                                                           |        29
      18   |*****                                                       |       101
      19   |*                                                           |        27
      20   |*                                                           |        29
      21   |*                                                           |        33
      22   |*                                                           |        17
      23   |*                                                           |        20
      24   |*                                                           |        21
      25   |*                                                           |         5
      26   |*                                                           |        14
    -------------------------------------------------------------------------------

    adafin:

The information that is displayed has the following meaning:

Keyword | Meaning
--- | ---
Length | Each value n shown in this column indicates that there is a descriptor value with a length of n bytes in the file. The range of values in this column lies between the minimum (column "min") and maximum (column "max") values shown in the table before the histogram.
Frequency | The value shown in this column indicates the number of descriptor values for the given descriptor length. The sum of the values in the frequency column is equal to the total number of values for the descriptor in question.

If all of the descriptor values are of the same length, the histogram will be of an unusual type, e.g.:

    adafin: file=9, histogram, descriptor=aa
    Database 1, File     9  (EMPLOYEES       )          27-OCT-2006 08:15:16

    Descriptor AA , Format: A , Options: UQ

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              8                8               8.00
    ISNs per value                      1                1               1.00

    Values:       different:              1,107     total:              1,107
    ASSO-Blocks:         NI:                  5        UI:                  1

    Histogram of descriptor value length for descriptor AA

    Length |             25%            50%            75%          100%| Frequency
    -------+--------------+--------------+--------------+---------------+----------
       8   |************************************************************|     1,107
    -------------------------------------------------------------------------------

This histogram shows that the file only contains descriptor values that have a length of 8 bytes. The file contains a total of 1107 values for the descriptor AA.

#### Example (with NOHISTOGRAM)

    adafin: file=9, histogram, descriptor=ap
    Database 1, File     9  (EMPLOYEES       )          27-OCT-2006 08:14:24

    Descriptor AP , Format: W , Options: NU

                                      min              max                ave
    -------------------------------------------------------------------------
    Length                              2               26              12.71
    ISNs per value                      1               75               4.61

    Values:       different:                240     total:              1,107
    ASSO-Blocks:         NI:                  3        UI:                  1

### USAGE

    USAGE = (keyword [,keyword [,keyword]])

Depending on the keyword specified, this parameter displays the percentage of used blocks in the file.

Keyword | Meaning
--- | ---
DS | Displays statistics of used blocks in the Data Storage;
NI | Displays statistics of used blocks in the Normal Index;
UI | Displays statistics of used blocks in the Main/Upper Index.

#### Example

    adafin: file=13, usage=ds

    Database 76, File    13  (MISCELLANEOUS   )          27-OCT-2006 08:16:18

    DS - Blocks allocated =         50 , used =         49 , unused =          1

    Records:  Number      =        179
              Length: max =      1,991 , min  =        260 , avg    =     997.47

      0%:                                                               0 blocks
      5%:                                                               0 blocks
     10%:                                                               0 blocks
     15%:                                                               0 blocks
     20%:                                                               0 blocks
     25%:                                                               0 blocks
     30%:                                                               0 blocks
     35%:                                                               0 blocks
     40%:                                                               0 blocks
     45%:                                                               0 blocks
     50%:                                                               0 blocks
     55%:                                                               0 blocks
     60%:                                                               0 blocks
     65%:                                                               0 blocks
     70%:****                                                           2 blocks
     75%:                                                               0 blocks
     80%:**                                                             1 block
     85%:*************                                                  6 blocks
     90%:*****************************                                 13 blocks
     95%:************************************************************* 27 blocks
    100%:                                                               0 blocks

Information about the used data blocks of file 13 in database 76 is displayed. 50 DS blocks are allocated, of which 49 are in use and 1 is unused. The total number of records is 179, with the record length varying between a maximum of 1991 and a minimum of 260. The average record length is 997.47. The following lines give an overview of the number of blocks that are used up to a given level. The majority of the blocks (27) is used up to between 90% and 95%.

#### Example (for ADAM file)

    adafin: file = 8
    adafin: adam_ds = full
    adafin: usage = ds

    Database  30, File   8 (ADAM_FILE       )      11-OCT-2006 12:08:57

    ADAM key = FF     ADAM parameter =     5               ADAM_DS = FULL

    DS - Blocks used for ADAM =          94
    Total overflow blocks     =           1,  used = 1

    Records:  Number      =    3863
              In ADAM area=    3860 , ovfl =        3
              Length: max =       9 , min  =        9 , avg    =      9.00

      0%: ********                                               10 blocks
      5%: ***                                                     4 blocks
     10%:                                                         0 blocks
     15%:                                                         0 blocks
     20%:                                                         0 blocks
     25%:                                                         0 blocks
     30%: *                                                       1 block
     35%:                                                         0 blocks
     40%:                                                         0 blocks
     45%:                                                         0 blocks
     50%: *                                                       1 block
     55%:                                                         0 blocks
     60%:                                                         0 blocks
     65%: **************************************************     74 blocks
     70%:                                                         0 blocks
     75%:                                                         0 blocks
     80%:                                                         0 blocks
     85%:                                                         0 blocks
     90%:                                                         0 blocks
     95%: ***                                                     3 blocks
    100%: *                                                       2 blocks

Information about all data blocks of file 8, which is an ADAM file, is displayed. The ADAM parameter is set to 5. 94 blocks are used for the ADAM area, with 1 block reserved for overflow. The ADAM area contains 3860 records, and 3 records are in the overflow area.

### On this page

- Functional Overview
- Procedure Flow
- Checkpoints
- Control Parameters