Agile Data Documentation

Contents:

• Overview
  • Simple to learn
  • Not a traditional ORM
  • Concern Separation
    • Class: Field
    • Class: Model
    • Class: Persistence
  • Code Layers
    • Domain-Model Code
    • Persistence-specific code
    • Generic Persistence-code
  • Persistence Scaling
• Quickstart
  • Requirements
  • Core Concepts
    • Persistence Domain vs Business Domain
    • Class vs In-Line definition
    • Model State
  • Getting Started
    • Adding Fields
    • Table Joins
    • Understanding Persistence
  • References between Models
    • One to Many
    • Many to Many
    • One to One
    • Implementation of References
  • Actions
    • Aggregation actions
    • Field-reference actions
    • Advanced Use of Actions
  • Expressions
  • Conclusion
• Introduction to Architectural Design
  • The Domain Layer Scope
    • The Danger of Raw Queries
    • Purity levels of Domain code
  • Domain Logic
    • Domain Models
    • Domain Model Methods
    • Domain Model Fields
    • Domain Model Relationship
  • Persistence backed Domain Logic
    • ID Field
  • Persistence-specific Code
    • Domain Model Expressions
    • Persistence Hooks
  • DataSet Declaration
  • Domain Conditions
  • Related DataSets
    • Domain Model Actions
    • Unique Features of Persistence Layer
• Model
  • Understanding Model
    • Model object = Data Set
    • Model object = meta information
    • Domain vs Persistence
    • Good naming for a Model
  • Initialization
    • Fields
    • Actions
    • Hooks
    • Inheritance
  • Associating Model with Database
  • Populating Data
  • Working with selective fields
  • Setting and Getting active record data
  • Title Field, ID Field and Model Caption
    • ID Field
    • Title Field
    • Model Caption
  • Setting limit and sort order
• Typecasting
  • Value types
    • Undefined type
    • Type of IDs
    • Supported types
    • Types and UI
  • Serialization
    • Array and Object types
• Loading and Saving (Persistence)
  • Associating with Persistence
    • Inserting Record with a specific ID
  • Type Converting
    • Strict Types an Normalization
    • Typecasting
    • Validation
    • Multi-column fields
    • Dates and Time
    • Customizations
  • Duplicating and Replacing Records
    • Create copy of existing record
    • Duplicate then save under a new ID
  • Working with Multiple DataSets
    • Cloning versus New Instance
    • Looking for duplicates
    • Archiving Records
  • Working with Multiple Persistencies
    • Creating Cache with Memcache
    • Using Read / Write Replicas
    • Archive Copies into different persistence
    • Store a specific record
  • Actions
    • Action Types
    • SQL Actions
    • SQL Actions on Linked Records
    • Action Matrix
• Fetching results
  • Iterate through model data
    • Raw Data Fetching
    • Fetching data through action
• Field
  • Purpose of Field
    • Field Type
    • Basic Properties
    • UI Presentation
• Conditions and DataSet
  • Basic Usage
    • Operations
    • Multiple Conditions
    • Adding OR Conditions
    • Defining your classes
  • Vendor-dependent logic
    • Field Matching
    • Expression Matching
    • SQL Expression Matching
    • Custom Parameters in Expressions
    • Expression as first argument
  • Advanced Usage
    • Model Scope
    • Conditions on Referenced Models
• SQL Extensions
  • Default Model Classes
    • SQL Field
    • SQL Reference
    • Expressions
  • Transactions
  • Custom Expressions
  • Actions
    • Action: select
    • Action: count
    • Action: field
    • Action: fx
  • Stored Procedures
    • Compatibility Warning
    • as a Model method
    • as a Model Field
    • as an Action
    • as a Temporary Table
    • as a Model Source
• Static Persistence
  • Usage
    • Saving Records
• References
  • Persistence
  • Safety and Performance
  • hasMany Reference
    • Dealing with many-to-many references
    • Dealing with NON-ID fields
    • Concatenating Fields
    • Add Aggregate Fields
    • Available Aggregation Functions
    • Aggregate Expressions
  • hasMany / refLink
  • hasOne reference
    • Traversing loaded model
    • Traversing DataSet
    • Importing Fields
    • Importing hasOne Title
  • User-defined Reference
  • Reference Discovery
  • Deep traversal
  • Reference Aliases
  • Various ways to specify options
  • References with New Records
  • Reference Classes
• Expressions
  • Defining Expression
  • No-table Model Expression
  • Expression Callback
  • Model Reloading after Save
• Model from multiple joined tables
  • Join Basics
    • Strong and Weak joins
    • Join relationship definitions
    • Method Proxying
    • Create and Delete behavior
    • Implementation Detail
  • SQL-specific joins
    • Implementation Details
    • Specifying complex ON logic
• Model Aggregates
  • Grouping
• Hooks
  • Model Operation Hooks
    • Example with beforeSave
    • Arguments
    • Interrupting
    • Insert/Update Hooks
    • beforeSave, afterSave Hook
    • Loading, Deleting
    • Hook execution sequence
    • How to prevent actions
    • onRollback Hook
  • Persistence Hooks
    • Persistence\Sql
  • Other Hooks:
• Advanced Topics
  • SubTypes
    • Best practice for specifying relation type
    • Type substitution on loading
  • Audit Fields
  • Soft Delete
    • Soft Delete that overrides default delete()
  • Creating Unique Field
  • Using WITH cursors
  • Creating Many to Many relationship
    • 1. Create Intermediate Entity - InvoicePayment
    • 2. Update Invoice and Payment model
    • 3. How to use
  • Creating Related Entity Lookup
  • Inserting Hierarchical Data
  • Related Record Conditioning
  • Narrowing Down Existing References
• Loading and Saving CSV Files
  • Setting Up
  • Exporting and Importing data from CSV

Agile DSQL Documentation

Contents:

DSQL

• Overview
  • Goals of DSQL
  • DSQL by example
  • DSQL is Part of Agile Toolkit
• Quickstart
  • Basic Concepts
  • Getting Started
  • Creating Objects and PDO
  • Query Building
  • Query Mode
  • Fetching Result
• Connection
• Expressions
  • Properties, Arguments, Parameters
    • Parameters
  • Creating Expression
  • Expression Template
  • Nested expressions
  • Rendering
  • Executing Expressions
  • Magic an Debug Methods
  • Escaping Methods
  • Other Properties
• Queries
  • Method invocation principles
  • Query Modes
  • Chaining
  • Using query as expression
  • Modifying Select Query
    • Setting Table
    • Setting Fields
    • Setting where and having clauses
    • Grouping results by field
    • Concatenate group of values
    • Joining with other tables
    • Use WITH cursors
    • Limiting result-set
    • Ordering result-set
  • Insert and Replace query
    • Set value to a field
    • Set Insert Options
  • Update Query
    • Set Conditions
    • Set value to a field
    • Other settings
  • Delete Query
    • Set Conditions
    • Other settings
  • Dropping attributes
  • Other Methods
  • Properties
• Results
• Transactions
• Advanced Topics
  • Advanced Connections
    • Using DSQL without Connection
    • Using in Existing Framework
  • Extending Query Class
    • Adding new vendor support through extension
    • Adding New Query Modes
  • Manual Query Execution
  • Exception Class
• Vendor support and Extensions
  • 3rd party vendor support

Indices and tables

• Index

• Search Page