❖ PrimaryToPrimaryKey

❖ SDV Enterprise bundle. This feature is available for purchase as an SDV Enterprise bundle. For more information, visit our page to Explore SDV.

Use the PrimaryToPrimaryKey CAG Pattern when you have an exact 1-to-1 connection between the primary keys of two or more tables.

In this example, the table 'Users' has an exact 1-to-1 relationship with the table 'Supplemental Info'. Both tables are connected via the same primary key ID value.

Pattern API

This functionality is in Beta. At this time, select SDV Enterprise users have been invited to use this feature.

Create a PrimaryToPrimaryKey pattern object

Parameters:

• (required) table_names: A list of strings, representing the table names whose primary keys are all connected. You must provide two or more table names.

from sdv.cag import PrimaryToPrimaryKey

my_pattern = PrimaryToPrimaryKey(
    table_names=['Users', 'Supplemental Info'])

Make sure that all the tables in you provide are in your Metadata, and have a primary key associated with them.

Usage

Apply the pattern to any SDV synthesizer. Then fit and sample as usual.

synthesizer = HSASynthesizer(metadata)
synthesizer.add_cag(patterns=[my_pattern])

synthesizer.fit(data)
synthetic_data = synthesizer.sample()