4
Tables with Foreign Keys
4 Outgoing
Keys
Field Name (in English),
Description, Notes, Value Options
Field Name (in Database), Data Type, Key Info
|
fields Unique ID
fld_id
Number, Indexed, Primary Key
|
Field Database ID
Indicates the unique Database ID number which this Field belongs to. This is important to track for generic fields which are not related to a specific Database Table.
| |
Field Table ID
Indicates the unique Table ID number which this Field belongs to. Notes: The parent table where this field is used. Only Generic fields have no table assigned. (Hernandez p.279)
| |
Field Sorting Order in Table
Indicates the indexed order of this Field, relative to other Fields within their Database Table. This is only important for presenting the list of Fields to a Database Designer.
( default value: 0 )
fld_ord
| |
Field Specification Type
Indicates whether this Database Field specification is Unique Field to this Table's instance, or is a Replica Field of a Generic Field shared by multiple Tables, or is itself a Generic Field. This can be important for documenting which Fields might need to maintain parallel changes in their specifications. Notes: Unique - any kind of field that will appear only once within the entire database or a primary key; Generic - a field that serves as a template for other fields within the database; Replica - a field that you base on a given generic field or a foreign key; (Hernandez p.279)
Values:
Unique ; Generic ; Replica
( default value: Unique )
fld_spec_type
| |
Field Spec Generic Source
If this record specification type indicates that it stores a Replica Field, then this information represents the unique Field ID of related the Generic Field. Notes: If this field is a Replica, the Specification Source is set to the Generic field which it mimics. To turn this field into a Replica, select a Generic field from the dropdown and click the Load link. To save a copy of this field as a Generic for future reuse, click the Save As Generic link. (Hernandez p.281)
( default value: -3 )
| |
Field Name (in Database)
Indicates the shorter Field Name without spaces or special characters which is used to technically identify this Field when accessing its stored values in the Database. During system use, the Table's Prefix will be added to the start of the Field Name in this record. Notes: Absolute minimal words that uniquely identifies this field, following database requirements (like probably no spaces). The table abbreviation name will be tacked on to the beginning. (Hernandez p.277)
fld_name
| |
Field Name (in English)
Indicates the main, casual, name of the Database Field in English. Notes: This label is an alternate name by which you can identify the field within an end-user application interface. Something readable. (Hernandez p.279)
fld_eng
| |
Field Alias(es)
Indicates any other names this specific Field might be known as. Notes: A name (or set of names) that you use for the field in very rare circumstances. This must be used if there are two occurrences of this field in the same table. (Hernandez p.281)
fld_alias
| |
Field Description
Indicates the full description of this Database Field. This should generally be a sentence or two describing what information is stored in this Field, and why it is important. Notes: A complete interpretation of the field. Write a clear and succinct statement that accurately identifies the field and clearly states its purpose within the table. Avoid technical jargon, acronyms, abbreviations, and implementation-specific information. (Hernandez p.283)
fld_desc
| |
Field Internal Notes
Indicates the any important Notes related to this Database Field. This can be important for providing documentation or other internal comments about how or why this Field was designed in this way, or where a list of potentially stored values came from. Notes: Extra space for internal notes, often reserved for implementation-specific information, or planning in progress.
fld_notes
| |
Foreign Key Table ID
If this Field is a Foreign Key pointing to another Database Table, then this is where that unique Table ID is stored. This is important for tracking data linkages through the Database Design.
( default value: -3 )
| |
Degree of Participation: Outgoing Min
If this Field record defines a Foreign Key, then this helps indicate its degree of participation, the minimum number of this Table's records which can be related to a single record of the Foreign Table. This is important for documenting and enforcing logical limitations designed with the Database.
( default value: 1 )
fld_foreign_min
| |
Degree of Participation: Outgoing Max
If this Field record defines a Foreign Key, then this helps indicate its degree of participation, the maximum number of this Table's records which can be related to a single record of the Foreign Table. This is important for documenting and enforcing logical limitations designed with the Database.
( default value: 1 )
fld_foreign_max
| |
Degree of Participation: Incoming Min
If this Field record defines a Foreign Key, then this helps indicate its degree of participation, the minimum number of a Foreign Table's records which can be related to a single record of this Table. This is important for documenting and enforcing logical limitations designed with the Database.
( default value: 1 )
fld_foreign2_min
| |
Degree of Participation: Incoming Max
If this Field record defines a Foreign Key, then this helps indicate its degree of participation, the maximum number of a Foreign Table's records which can be related to a single record of this Table. This is important for documenting and enforcing logical limitations designed with the Database.
( default value: 1 )
fld_foreign2_max
| |
Field Values
Storing information here indicates that this Database Field can only be set to a specified range of values, separated by semi-colons. (* This field needs to be replaced by a helper table which stores each value as its own record, or perhaps preferably using the Definitions table. *) Notes: Specifies every possible valid value for a field. You can optionally select a pre-definined value set which is common among various fields. (Hernandez p.294)
fld_values
| |
Default Value
Indicates the default value for this specific Field, when a new Table record is first created. Notes: A value that a user can into a field when a more appropriate value is not yet available, nulls not allowed. Use a default value ONLY if it is meaningful. (Hernandez p.294)
fld_default
| |
Is Indexed
Indicates whether or not this Field is to be indexed by the Database for faster searching of this specific field. This is important for ideal Database creation. Notes: When this project is finished, will this field be searched or sorted very very often? A database index is a data structure that improves the speed of data retrieval operations on a database table at the cost of additional writes and storage space to maintain the index data structure. (NOT Hernandez approved planning.)
Values:
0 ; 1
( default value: 0 )
fld_is_index
| |
MySQL Data Type
Indicates which basic MySQL type of data will be stored with this Database Field. This is important for determining how to export the database or otherwise install it to MySQL-based environments. Notes: MySQL implementation-specific field type, needed for one-click database structure export. (NOT Hernandez approved planning.)
( default value: VARCHAR )
fld_type
| |
Basic Data Type
Indicates the most basic nature of the data being stored by this Field, whether . Notes: The most basic nature of the data that this field stores (not implementation-specific). (Hernandez p.286)
Values:
Alphanumeric ; Numeric ; DateTime
( default value: Alphanumeric )
fld_data_type
| |
Data Length
Indicates the total number of characters or digits that a user can enter for any stored value in this Database Field. This is important for ideal Database creation. Notes: The total number of characters or digits that a user can enter for any given value of this field. If otherwise unimportant, this can be set to the maximum length for the best implementation-specific data type. (Hernandez p.289)
fld_data_length
| |
Data Decimal Places
If this Field's basic data type is numeric, then this denotes the number of digits to the right of the decimal point in real numbers which can be stored in this Database Field. Notes: If this field is Numeric, this denotes the number of digits to the right of the decimal point in a real number (eg. MySQL DOUBLE). (Hernandez p.289)
( default value: 0 )
fld_data_decimals
| |
Character Support
Indicates the type of characters that a user can enter as a value for this Database Field. (* Multiple character types are currently stored as comma separated strings, but this should probably be some cleaner method. *) Notes: The type of characters that a user can enter as a value for this field. Setting and enforcing this helps you ensure that the user cannot introduce meaningless data into the field, enhancing field-level integrity. Letters include foreign language letters. (Hernandez p.289)
Values:
Letters ; Numbers ; Keyboard ; Special
( default value: ,Letters,Numbers,Keyboard,Special, )
fld_char_support
| |
Input Mask
Specifies the manner in which a user should enter data into this field. eg. YYYY-MM-DD Notes: Specifies the manner in which a user should enter data into this field. eg. YYYY-MM-DD (Hernandez p.290)
fld_input_mask
| |
Display Format
Indicates the appearance of this Database Field's value when it is displayed on a screen or printed within a document. Notes: The appearance of this field's value when it is displayed on a screen or printed within a document. (Hernandez p.291)
fld_display_format
| |
Key Type
Indicates whether or not this Field is some kind of Key in its parent Database Table, including Foreign Keys, Primary Keys, or Alternate Keys. By default, all Survloop Tables will automatically generate a Unique, Primary Key if no such Field is specified by the Database Designer. (* Multiple key types are currently stored as comma separated strings, but this should probably be some cleaner method. *) Notes: Designates this field's role within a table. (Hernandez p.292)
Values:
Non ; Foreign ; Primary ; Alternate
( default value: ,Non, )
fld_key_type
| |
Key Structure
If this Database Field is a Primary Key, then this indicates whether it is acting as a simple (single-field) primary key or as part of a composite (multi-field) primary key. Notes: Denotes whether this field designated as a primary key is acting as a simple (single-field) primary key or as part of a composite (multi-field) primary key. (Hernandez p.292)
Values:
Simple ; Composite
fld_key_struct
| |
Edit Rule
Indicates whether or not a Field's data can or must be store at the Table record's creation, and whether or not it can it be edited by Users later. Notes: Enter Now - user must enter a value when creating a new table record; Enter Later - user has the option of entering value when creating table record; Edits Allowed - user can edit the value at any time; Edits Not Allowed - after entering a value, user cannot edit it at any time; (Hernandez p.295)
Values:
NowAllowed ; LateAllow ; NowNot ; LateNot ; NotDeterm
( default value: LateAllow )
fld_edit_rule
| |
Has Unique Value
Indicates whether this Database Field's values are unique across all Table records. Notes: Indicates whether this field's values are unique (always for primary keys, rarely for everything else). (Hernandez p.292)
Values:
0 ; 1
( default value: 0 )
fld_unique
| |
Has NULL Support
Indicates whether or not this Database Field accepts NULL values to be stored, which should represent missing or unknown information. Notes: Whether this field accepts null values (not allowed for primary keys). Null values should represent missing or unknown values. (Hernandez p.293)
Values:
0 ; 1
( default value: 1 )
fld_null_support
| |
Values Entered By
Indicates whether a User or the System enter information into this Database Field. Notes: The source of this field's value. Either a user will enter values into the field manually or a database application program will enter them automatically. (Hernandez p.293)
Values:
User ; System
( default value: User )
fld_values_entered_by
| |
Is Required
Indicates whether or not a User is required to enter a value for this Database Field. Notes: Whether a user is required to enter a value for this field. No for most non-primary-key fields. (Hernandez p.294)
Values:
0 ; 1
( default value: 0 )
fld_required
| |
Compare Same Field Value
Indicates the types of comparisons can be applied to a given field value when retrieving information from the same Field in other Table records. Currently stored as the multiple of various prime numbers which represent the specific comparisons allowed. Notes: The types of comparisons a user/system can apply to a given field value when retrieving information from the field. (Hernandez p.296)
( default value: 1 )
fld_compare_same
| |
Compare Other Field Value
Indicates the types of comparisons can be applied to a given field value when retrieving information from the other Fields in other Table records. Currently stored as the multiple of various prime numbers which represent the specific comparisons allowed. Notes: The types of comparisons a user/system can apply to a given field value when retrieving information from the field. (Hernandez p.296)
( default value: 1 )
fld_compare_other
| |
Compare Other Values
Indicates the types of comparisons can be applied to a given field value when retrieving information from the other values generally. Currently stored as the multiple of various prime numbers which represent the specific comparisons allowed. Notes: The types of comparisons a user/system can apply to a given field value when retrieving information from the field. (Hernandez p.296)
( default value: 1 )
fld_compare_value
| |
Operate with Same Field Value
Indicates the types of operations which can be applied to a given Field value with the same Field in other Table records. Currently stored as the multiple of various prime numbers which represent the specific comparisons allowed. Notes: Specifies the types of operations that a user can perform on the values. (Hernandez p.298)
( default value: 1 )
fld_operate_same
| |
Operate with Other Field Value
Indicates the types of operations which can be applied to a given Field value with the other Fields in other Table records. Currently stored as the multiple of various prime numbers which represent the specific comparisons allowed. Notes: Specifies the types of operations that a user can perform on the values. (Hernandez p.298)
( default value: 1 )
fld_operate_other
| |
Operate with Other Value
Indicates the types of operations which can be applied to a given Field value with the other values generally. Currently stored as the multiple of various prime numbers which represent the specific comparisons allowed. Notes: Specifies the types of operations that a user can perform on the values. (Hernandez p.298)
( default value: 1 )
fld_operate_value
| |
Field Options
Indicates the multiple of various prime numbers which mark other specific qualities of this Field. Notes: %3 Field Is Auto-Managed by Survloop; | %1 XML Public Data; %7 XML Private Data; %11 XML Sensitive Data; %13 XML Internal Use Data;
( default value: 1 )
fld_opts
| |