Skip to main content

RWTH Aachen Computer Science i5/dbis assets for Lecture Datenbanken und Informationssysteme

Project description

DBIS Functional Dependencies

Functional Dependencies and Normal Forms for Relational Databases

PyPI Status pypi License Pipeline Status

This library provides a Python implementation of the synthesis algorithm and decomposition algorithm according to the DBIS lecture. For more background and application of functional dependencies and the algorithms, see Doku-FunctionalDependencies.

Features

  • Create sets of Functional dependencies (FDSets).
  • Calculate candidate keys of an FDSet.
  • Calculate attribute closure of an attribute or set of attributes.
  • Test whether an FDSet is in 2NF, 3NF or BCNF.
  • Execute the synthesis algorithm to transform the FDSet into 3NF.
  • Execute the decomposition algorithm to transform the FDSet into BCNF.
  • Generate the closure $F^+$ of an FDSet $F$.
  • Generate true/false questions w.r.t. synthesis and decomposition algorithm.

Installation

Install via pip:

pip install dbis-functional-dependencies

Usage

Creating an FDSet

Create a new instance of FunctionalDependencySet. The set of attributes is passed as parameter.

fdset = FunctionalDependencySet('ABCDE')

You can add more attributes later by using the add_attribute function.

fdset.add_attribute('F')

Add dependencies with the add_dependency function ...

fdset.add_dependency("AC", "DE")
fdset.add_dependency("DEF", "B")
fdset.add_dependency("B", "D")

... or remove them with the remove_dependency function.

fdset.remove_dependency("B", "D")

Printing an FDSet shows the dependencies in a more readable form.

print(f"{fdset}")

Attribute closure and candidate keys

Calculate the attribute closure of one or multiple attributes.

closureA = fdset.get_attr_closure('A')
closureAC = fdset.get_attr_closure('AC')

Calculate all candidate keys.

ckeys = fdset.find_candidate_keys()

Check for normal forms

Since we only work with schemas (no actual values for the attributes), we assume that a corresponding database is in 1NF.

Check whether the FDSet is in 2NF, 3NF or BCNF.

is2NF = fdset.is2NF()
is3NF = fdset.is3NF()
isBCNF = fdset.isBCNF()

Execute the synthesis algorithm

Execute the synthesis algorithm on an FDSet to generate a corresponding list of FDSets in 3NF.

fdslist = fdset.synthesize()

The algorithm performs the following steps:

  1. Find the candidate keys.
  2. Calculate the canonical cover.
    • left reduction
    • right reduction
    • remove dependencies with empty rhs
    • combine dependencies with same lhs
  3. Create a new relation for every dependency in the canonical cover.
  4. Create the optional key scheme if no candidate key is included in the attribute set of one of the relations of step 2.
  5. Remove subset relations.

You receive additional information on the steps of the algorithm by toggling the parameter verbose.

fdslist = fdset.synthesize(vebose=True)

Alternatively, you can also execute the single steps with the following functions:

fdset_step.canonical_cover()
fdslist_step = fdset_step.create_new_fdsets()
fdslist_step_with_key = FunctionalDependencySet.create_optional_key_scheme(self, ckeys, fdslist_step)
reduced_fdslist_step = FunctionalDependencySet.remove_subset_relations(self, fdslist_step_with_key)

The verbose option exists for all steps.

Execute the decomposition algorithm

Execute the decomposition algorithm on an FDSet to generate a corresponding decomposition of FDSets in BCNF.

fdslist = fdset.decompose2()

Before performing the actual algorithm, the the closure of the FDSet is calculated.

Closure of an FDSet

Calculate the closure $F^+$ of an FDSet $F$.

fdset.completeFDsetToClosure()

This function just adds dependencies with all subset combinations of the attribute set with their corresponding closures on the rhs of the dependency, so that no implicit dependency is missed by the decomposition algorithm.

Exercise generator

Generate true/false statements based on the different steps of the algorithms.

fdslist = fdset.synthesize(genEx=True)

The genEx option is available for the following functions:

  • find_candidate_keys
  • synthesize
    • canonical_cover
      • left_reduction
      • right_reduction
      • remove_empty_fds
      • combine_fds
    • create_new_fdsets
    • create_optional_key_scheme
    • remove_subset_relations
  • decompose2

Checking results against expected

Checks a given calculated step of an FDSet during the synthesis algorithm (according to the DBIS lecture) for correctness.

original = fdset.copy()
fdset.left_reduction()
original.isCorrectLeftReduction(fdset)

For this purpose, the following functions exist:

  • isCorrectLeftReduction
  • isCorrectRightReduction
  • isCorrectRemovingEmptyFDs
  • isCorrectCombinationOfDependencies
  • isCorrectCanonicalCover
  • isCorrectCreationOfNewFDS

These functions are called on the FDSet with all steps before already calculated on it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbis_functional_dependencies-1.0.1.tar.gz (40.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dbis_functional_dependencies-1.0.1-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

Details for the file dbis_functional_dependencies-1.0.1.tar.gz.

File metadata

File hashes

Hashes for dbis_functional_dependencies-1.0.1.tar.gz
Algorithm Hash digest
SHA256 c62669e97184fe748a1ec5cc774734b528f2acc3fdc38d5b71d056ed6849a47c
MD5 8714fa858ac543648052e45bd266ba85
BLAKE2b-256 0e6c5fe2111232b3888713d5a2cb8a24ee46df6e2eca5b41502f57a4099e32ce

See more details on using hashes here.

File details

Details for the file dbis_functional_dependencies-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for dbis_functional_dependencies-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 08442ac3b1f6cd9cc8117b85d205f89cd9641d5eeb8518036eb3f6afb6172121
MD5 f90ea4477d9736edd2cb37be8f7497ff
BLAKE2b-256 6e94c7dc0f17e04d99ee62bd3294709f48451946da0fc1b9f2b4a9e8c39eb490

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page