Properties

What is a Property?

A Property defines the characteristics or attributes of an Entity within a database. It specifies the type of data that can be stored and how it should be managed. Each Property is associated with a specific data type and comes with constraints set and configurations that dictate how data is handled.

Key Characteristics of a Property

  • Name: The unique identifier for the property within the entity.

  • Description: An optional field that provides additional context or explanation about the property.

  • Type: Specifies the data type of the property (e.g., Text, Number, Date / Time, Boolean). Each type has specific attributes and constraints.

    • Property Types:

      • Text: Stores textual data with constraints such as length and pattern.

      • Whole Number/Decimal: Manages numerical values with constraints on minimum and maximum values.

      • Date/Time: Handles date and time data, including formatting and range constraints.

      • Boolean: Represents true/false values.

      • Enum: Allows for a predefined set of values.

      • Lookup: Provides a list of predefined values with a structured format.

      • Object: Handles complex data structures with multiple fields.

      • File: Manages file uploads with constraints on file types and sizes.

      • Entity Reference: Links to another entity within the system.

  • Nullable: Specifies if the property can accept null values.

  • Searchable: Determines if the property can be used in search queries.

Example: For an "Employee" entity, consider the "Salary" property:

  • Name: Salary

  • Description: The employee's monthly salary.

  • Type: Whole Number

  • Nullable: No

  • Searchable: Yes

List Configuration (if applicable)

List Configuration refers to settings that define whether a property can hold multiple values and how these values should be managed. It includes:

  • Is List: Indicates if the property can hold multiple values.

  • Allow Duplicates: Specifies if duplicates are allowed within the list.

  • Min Items Allowed: Minimum number of items required in the list.

  • Max Items Allowed: Maximum number of items allowed in the list.

Example: For a "Skills" property in the "Employee" entity:

  • Is List: Yes

  • Allow Duplicates: Yes (if the employee can have the same skill listed multiple times in different contexts)

  • Min Items Allowed: 1 (at least one skill must be specified)

  • Max Items Allowed: 10 (up to ten skills can be listed)

Last updated