Download the PHP package darkghosthunter/rememberable-query without Composer
On this page you can find all versions of the php package darkghosthunter/rememberable-query. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download darkghosthunter/rememberable-query
More information about darkghosthunter/rememberable-query
Files in darkghosthunter/rememberable-query
Package rememberable-query
Short Description Remember a Query results in one expressive line
License MIT
Homepage https://github.com/darkghosthunter/rememberablequery
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package rememberable-query
Package superseeded by Laragear/CacheQuery
Rememberable Queries
Remember your Query results using only one method. Yes, only one.
Requirements
- PHP 8.0
- Laravel 8.x
Installation
You can install the package via composer:
Usage
Just use the remember() method to remember a Query result before the execution. That's it. The method automatically remembers the result for 60 seconds.
The next time you call the same query, the result will be retrieved from the cache instead of running the SQL statement in the database, even if the result is null or false.
The
remember()will throw an error if you build a query instead of executing it.
Time-to-live
By default, queries are remembered by 60 seconds, but you're free to use any length, Datetime, DateInterval or Carbon instance.
Custom Cache Key
The auto-generated cache key is an BASE64-MD5 hash of the SQL query and its bindings, which avoids any collision with other queries while keeping the cache key short.
You can use any string as you want, but is recommended to append query| to avoid conflicts with other cache keys in your application.
Alternatively, you can use an custom Cache Store for remembering queries.
Custom Cache Store
In some scenarios, using the default cache of your application may be detrimental compared to the database performance, or may conflict with other keys. You can use any other Cache Store by setting a third parameter, or a named parameter.
Cache Lock (data races)
On multiple processes, the Query may be executed multiple times until the first process is able to store the result in the cache, specially when these take more than 1 second. To avoid this, set the wait parameter with the number of seconds to hold the lock acquired.
The first process will acquire the lock for the given seconds, execute the query and store the result. The next processes will wait until the cache data is available to retrieve the result from there.
If you need to use this across multiple processes, use the cache lock directly.
Idempotent queries
While the reason behind remembering a Query is to cache the data retrieved from a database, you can use this to your advantage to create idempotent queries.
For example, you can make this query only execute once every day for a given user ID.
Subsequent executions of this query won't be executed at all until the cache expires, so in the above example we have surprisingly created a "unique views" mechanic.
Operations are NOT commutative
Altering the Builder methods order will change the auto-generated cache key hash. Even if they are visually the same, the order of statements makes the hash completely different.
For example, given two similar queries in different parts of the application, these both will not share the same cached result:
To ensure you're hitting the same cache on similar queries, use a custom cache key. With this, all queries using the same key will share the same cached result:
This will allow you to even retrieve the data outside the query, by just asking directly to the cache.
License
The MIT License (MIT). Please see License File for more information.
