Skip to main content
Skip table of contents

Configure the Database Catalogue

Use the SuperADMIN command cat to manage the database catalogue. With the cat command you can add the following 

  • Databases
  • Folders
  • Tables
  • Recode groups.

Once you have created the catalogue, you can also use the cat command to configure user access permissions.

List the Current Catalogue Structure

To see the current structure of the catalogue, type cat on its own. For example:

TEXT
> cat
[ Database Catalogue : SuperSTAR Database Server {root}  (maxfiles:-1)]
    [ AggregateStatFunction ]
        [ Family : (name:Parzen#1)]
    [ Folder : Users (id:Users) (Multilingual:false) (maxfiles:0) (files:0)]
    [ Database : Retail Banking (id:bank) (security:false) ]
    [ Enabled Stat Functions ]
    [ Quantile ]
        [ Algorithm : Step ]
        [ Confidentiality String : * ]
        [ Available Buckets : 2 3 4 5 6 7 8 9 10 ]
    [ Unitrecord ]
        [ Nullhandling : NullAsSkipped ]

You can find out more information about a specific database by typing cat followed by the database ID. For example:

TEXT
> cat bank
[ Database : Retail Banking (id:bank) (security:false) ]
    [ Location              : databases/RetailBanking.sxv4 ]
    [ Record View           : true   Enable : false ]
    [ Multilingual          : false ]
    [ Enable Recode Totals  : true ]
    [ Disable Methods       : false ]
    [ Select Table Methods  : false ]
    [ Server                : localhost ]

Add a Database to the Catalogue

Use the cat command to add a new database to the catalogue.

The basic syntax is (see the reference page for the cat command for full details):

TEXT
cat [ <folder_id> ] adddb <database_id> [ <display_name> ] <path_location> <server_id>

For example:

TEXT
cat adddb banking "Banking Customers" D:\Databases\BankingCustomers.sxv4 superserver 

Organise Databases into Folders

You can use folders to organise your databases. Use the cat command to create the folders and move your databases within the hierarchy.

The following example shows how we might:

  • Create a new folder.
  • Give the allusers group read access to the folder.
  • Move some of the existing databases from the root level into the new folder.
TEXT
> cat addfolder finance "Financial Databases"
Added folder 'finance' to databaseCatalog 'root'

> cat finance access allusers read true

> cat banking move finance
Successfully removed database 'banking' from server 'superserver'
Successfully installed database 'banking' to server 'superserver'
Successfully moved database 'banking' to folder 'finance'

> cat bank move finance
Successfully removed database 'bank' from server 'superserver'
Successfully installed database 'bank' to server 'superserver'
Successfully moved database 'bank' to folder 'finance'

> 

The folder structure will then be available when users are browsing the catalogue in the clients:

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.