Structure Key field

The Key Field allows you to do insert, update and delete loads, enabling you to insert new records, update or delete them based on the key configured in the structure

If the desired structure is already created, click on edit

In the "Data Source" tab enable structure editing

In the next tab "Structure" look for the "Key field".

Define your key field by clicking on "Define key field". It is recommended that the key field of the structure be either code (customer code, sales person, etc.) or date. You can also create multiple key fields, containing code and date, for example

With the changes made, proceed to edit and save the structure and wait for your full load to finish. This is because the key field defines a unique hash for each row in your database

After setting up the key field in your structure, you can make incremental load schedules that update or delete records always according to the key specified in the step shown above.

In its structure, click on the "three dots" and on "Load schedules".

Set the scheduling periodicity, and click "Next". On the next screen, select the type of load you want to run

The key field will not affect the total load on the structures, the data obtained in the query will be loaded into BIMachine in full. In the example case the ID field is the key of the structure.

In this case, with the key field configured, the data will be updated with the same key and new records inserted. In the case below 8 records were loaded, being 5 new (in green) and 3 existing ones that were updated (in blue).

The remove load will use the key returned in the data to delete the records found in the structure. In the case below 8 records (in red) were removed from the structure.