Download the PHP package niiknow/laratt without Composer

Laravel Table Tenancy (laratt)

Allow for multi-tenancy by using table prefix

Also see laratt-api where this project was originally built and refactored.

Install:

Config:

Features

• [x] Use special character $ for tenant and table separator. Most database allow for this character.
• [x] Dynamic table as tenant$table_name
• [x] Tenant resolution use x-tenant header/input by default; though, it is customizable by providing a static function for resolver config.
• [x] A generic Controller Trait that provide simple and flexible CRUD (create, retrieve, update, delete) REST endpoint.
• [x] Simple query and bulk delete /query REST endpoint.
• [x] jQuery DataTables as /data endpoint with laravel-datatables
• [x] Pre-defined structured schema for ProfileModel
• [x] Schedulable and ecommerce schema type for TableModel
• [x] Being able to include and exclude table from auditable - so you don't have to audit things like when you're using it for logging, caching, or when client doesn't need it for some particular reason.

CONS It doesn't support table relationship.

API Schema

The image below is from our Swagger documentation of the laratt-api project.

Table Schema

Special multi-tables endpoint @ /api/v1/tables/{table}; where {table} is the table name you want to create. {table} must be all lower cased alphanumeric and underscore with mininum of 3 characters to 30 max. Example, let say x-tenant: clienta and {table} = product, then the resulting table will be clienta$product.

Also note that there are two ids: id and uid. id is internal to laratt. You should be using uid for all operations. uid is an auto-generated guid, if none is provide during insert.

Providing a uid allow the API update to effectively act as an merge/upsert operation. This mean that, if you call update with a uid, it will update if the record is found, otherwise insert a new record.

• /query endpoint is use for query and bulk DELETE, see: Query Syntax
• /data endpoint is use for returning jQuery DataTables format using laravel-datatables.
• /import bulk import is csv to allow for bigger import. Up to 10000 records instead of some small number like 100 for Azure Table Storage (also see admin config to adjust). This allow for efficiency of smaller file and quicker file transfer/upload.
• /truncate truncate all data from table.
• /drop drop a table. Why not? Now you can do all kind of crazy stuff with table.

What about your own/custom schema? See example of our Profile Schema

Query-Syntax

This library provide simple query endpoint for search and bulk delete: api/v1/profile/query or api/v1/tables/{table}/query

Limiting

To limit the number of returned resources to a specific amount with keyword limit or per_page:

Sorting

To sort the resources by a column in ascending or descending order:

You could also have multiple sort queries:

Filtering

The basic format to filter the resources:

Note: The values are rawurldecode()d.

Filtering Options

You can also do OR and AND clauses. For OR clauses, use commas inside the same filter[] query:

For AND clauses, use another filter[] query.

RequestQueryBuilder server-side usage

Below demo ficticious server-side DonationController that provide Laravel Paginate json data for some client-side ui.

License

The MIT License (MIT). Please see License File for more information.