FlyingFish
FlyingFish on GitHub
  • FlyingFish
    • About the project
    • Screenshots
    • Installation
      • Quick Setup
      • Quick Update
      • Create Backup
      • Long setup
        • Env
        • Docker compose
          • Ports
          • Network
      • Storage management
      • FAQ
    • Configurations
      • Which user type am I
      • Listen
        • Port forwarding
        • Proxy protocol
        • IP Access
        • Gateway identifiers
        • UPnP Nat
      • Domains
        • DynDns Clients
        • Own DNS Server
        • Discussions Subdomains
        • DynDns Server
      • Routes
    • Examples
      • SSH hidden on HTTPS
      • FlyingFish to other reverse proxy
      • Backup Server, SSH to Nas
      • Own DynDNS Server - Fritzbox
      • Inventree - Route
    • Developer
      • Ideas, requests and bugs
      • Project structure
        • Under the hood
        • Service structure
        • Schema
        • Object name rules
      • Image build
      • Plugins
    • Contribution
Powered by GitBook
On this page
  • Schema objects
  • Database objects
Edit on GitHub
  1. FlyingFish
  2. Developer
  3. Project structure

Object name rules

Description of the names of the objects

Schema objects

The schema objects describe a data structure that is passed via a config or API. Schemas are validated for the data. Whenever it is important that a data structure must be correct, a schema object is used.

These objects start with the name Schema and then the actual name of the structure/record follows.

Example:

SchemaDomainRecord

and

DomainRecord

All these schemas are collected in the "schemas" library. These are used in several FlyingFish part programs or in the API.

Database objects

The DB objects were combined in the core library. Since several sub-programs of the FlyingFish share the DB in order to fulfill the tasks accordingly. If data/settings are changed in the frontend via the backend and saved in the DB, the SSH jump server, for example, can use them immediately.

Objects beginning with DB

Are neutral DB objects that provide interfaces to the DB: Examples:

  • DBHelper

  • DBBaseEntityId

  • DBService

  • ...

Objects ending with DB

Are data or service (for the data) DB objects, these handle the data to the DB.

  • DomainDB

  • UserDB

  • DomainServiceDB

  • ...

PreviousSchemaNextImage build

Last updated 1 year ago