Skip to content

Update README.md to document dateAlias method #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md to document dateAlias method #78

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,23 @@ Trend::model(Order::class)

This allows you to work with models that have custom date column names or when you want to analyze data based on a different date column.

## Date Column Alias

By default, laravel-trend creates a grouping select field in its database query named `date`. This can cause problems if you have a column on that table already named `date`. To avoid this conflict in the query specify a different name with `dateAlias(string $alias)` method.

Example:

```php
Trend::model(Order::class)
->dateColumn('date')
->dateAlias('date_alias')
->between(...)
->perDay()
->count();
```

This allows you to work with models that have a column named `date`.

## Drivers

We currently support four drivers:
Expand Down