Calgary Loader Tool Icon

Calgary Loader Tool

Version:
Current
Last modified: December 27, 2019

The Calgary Loader enables you to create a Calgary database (*.cydb) from any type of Input file. Each field contained in the Input file can be indexed to maximize the Calgary database performance.

As of the Alteryx 5.0 release, Calgary indexes are case insensitive. Calgary databases created in a version earlier than 5.0 will still be case sensitive.

Tool Configuration

Root File Name: The area used to specify the name of the Calgary database and file location. All Calgary databases have the file extension *.cydb.

You can choose to either to Load base CalgaryDB and/or 1 or more standard indexes or to Load a single advanced index.

Load base CalgaryDB and/or 1 or more standard indexes

Fields: The Fields area will display every column of data contained in your Input file.

There is an Options button on the right side. Options included are:

Data: Fields chosen in the Data column will be available for retrieval. You can manually select or deselect data to be included in the Calgary database by either checking or unchecking the box next the data field.

  • Select all: Selects all data fields for the analysis.
  • Deselect all: Deselects all data fields in one step. This is useful in the case of wanting to select only a few fields to carry through the workflow.

Index: Fields chosen in the Index column will be available for queries. You can manually select or deselect indexes to be created on the Calgary database by either checking or unchecking the box next the data field.

  • Select all: Selects all data fields for the analysis.
  • Deselect all: Deselects all data fields in one step. This is useful in the case of wanting to select only a few fields to carry through the workflow.

Field can be set to either spatial or non-spatial indexes. There are two different modes for creating non-spatial indexes:

  • High Selectivity Index: A high selectivity index is used for fields containing very unique records such as address or name.
  • Low Selectivity Index: A low selectivity index is used for fields containing repetitive data such as gender or state abbreviation.

You can select an auto mode in which the Calgary Loader tool will automatically apply the proper index mode (High or Low Selectivity) based on the data contained in the Input field. All fields with more than 550 unique values will autodetect to high selectivity. The Calgary Loader will begin to build both High and Low selectivity indexes for the first 1 million records in order to identify the proper index to apply.  The auto mode can incorrectly assign the proper index mode if the nature of the data significantly changes within the first million record.

NULL values are allowed in non-spatial indexes.

Only point level spatial indexes are supported. NULL and 0,0 points cannot be spatially indexed.

Load a single advanced index

The Advanced Index allows you to create a contains or raw index on a Calgary Database.

Contains Index: Searches the entire tabular field for a specified value. The specified value can be located anywhere within the field.

Raw Index: A special build mode for standard indexes used to create one index for multiple fields in a table.

If a table contains fields for Person 1 through Person 6, an index can be created to contain all names from all six person fields. This enables you to perform a search on one name and retrieve all records where there is a match regardless of which Person field the name value resides.

Root File Name:  Specify the Calgary database for which you will create an Advanced Index. Either type in the file path location of the input or click Browse to navigate to the file location.

Index Name: Specify the name of the advanced index to be saved in the same location as the Root File Name.

  • Source Field: Specify the field from the Input database for which you would like to create an advanced index on.
  • Advanced Index Mode: Specify the type of advanced index to create: contains or raw.

For Raw Indexes, you must specify the 0 Based Record Field which is the record ID and the Selectivity : High, Low, or Auto.

Require a License to use this file: This check box is mostly for internal use. Do not check this box when loading a Calgary Database unless you have authorization to build a license file.

See Building a Raw Index in Calgary Loader.

Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.