Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankane/groupdate.sql
The simplest way to group temporal data
https://github.com/ankane/groupdate.sql
Last synced: about 1 month ago
JSON representation
The simplest way to group temporal data
- Host: GitHub
- URL: https://github.com/ankane/groupdate.sql
- Owner: ankane
- License: mit
- Created: 2013-05-22T03:53:45.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-06-30T23:54:59.000Z (3 months ago)
- Last Synced: 2024-07-05T05:26:38.905Z (2 months ago)
- Language: PLpgSQL
- Homepage:
- Size: 92.8 KB
- Stars: 283
- Watchers: 10
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- jimsghstars - ankane/groupdate.sql - The simplest way to group temporal data (PLpgSQL)
README
# Groupdate.sql
The simplest way to group by:
- day
- week
- month
- day of the week
- hour of the day
- and more
:tada: Time zones supported!!
Supports PostgreSQL and MySQL
[](https://github.com/ankane/groupdate.sql/actions)
## Installation
Run this SQL
- [PostgreSQL](https://raw.githubusercontent.com/ankane/groupdate.sql/master/postgresql/install.sql)
- [MySQL](https://raw.githubusercontent.com/ankane/groupdate.sql/master/mysql/install.sql)
For MySQL, [time zone support](https://dev.mysql.com/doc/refman/8.0/en/time-zone-support.html) must be installed on the server.
```sh
mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
```
## Getting Started
Groupdate.sql creates SQL functions, which are stored by the database. You can use these functions with any ORM or without one. Times stored in your database are assumed to be UTC (this is the default for frameworks like Rails).
Group by day
```sql
SELECT gd_day(created_at, 'America/Los_Angeles') AS day, COUNT(*) FROM users GROUP BY day;
-- result
day | count
------------+-------
2013-04-11 | 145
2013-04-12 | 65
2013-04-13 | 293
```
Group by week
```sql
SELECT gd_week(created_at, 'America/Chicago') AS week, COUNT(*) FROM users GROUP BY week;
-- result
week | count
------------+-------
2013-05-05 | 1327
2013-05-12 | 3432
2013-05-19 | 673
```
> Weeks start on Sunday by default
Group by dynamic period
```sql
SELECT gd_period('day', created_at, 'America/Los_Angeles') AS period, COUNT(*) FROM users GROUP BY period;
```
> Works with `day`, `week`, `month`, and `year`
## Functions
Here’s the complete list of functions. All are prefixed with `gd_` to prevent conflicts with MySQL functions.
- second
- minute
- hour
- day
- week
- month
- quarter
- year
- hour_of_day
- day_of_week
- day_of_month
- day_of_year
- month_of_year
A list of time zones can be found [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
## Options
### Time Zone
With PostgreSQL, the time zone is optional.
```sql
SELECT gd_day(created_at) AS day, COUNT(*) FROM users GROUP BY day;
```
The default is UTC. Change this to your preferred time zone by running:
```sql
CREATE OR REPLACE FUNCTION gd_time_zone()
RETURNS text AS
$$
SELECT 'America/Los_Angeles'::text;
$$
LANGUAGE SQL IMMUTABLE;
```
### Week Start
Set the day weeks start. The default is Sunday.
For PostgreSQL, run:
```sql
CREATE OR REPLACE FUNCTION gd_week_start()
RETURNS int AS
$$
SELECT 6; -- mon=0, tue=1, wed=2, thu=3, fri=4, sat=5, sun=6
$$
LANGUAGE SQL IMMUTABLE;
```
For MySQL, run:
```sql
START TRANSACTION;
DROP FUNCTION IF EXISTS gd_week_start;
CREATE FUNCTION gd_week_start()
RETURNS INT DETERMINISTIC
RETURN 6; -- mon=0, tue=1, wed=2, thu=3, fri=4, sat=5, sun=6
COMMIT;
```
## Uninstall
Run this SQL
- [PostgreSQL](https://raw.githubusercontent.com/ankane/groupdate.sql/master/postgresql/uninstall.sql)
- [MySQL](https://raw.githubusercontent.com/ankane/groupdate.sql/master/mysql/uninstall.sql)
## History
View the [changelog](https://github.com/ankane/groupdate.sql/blob/master/CHANGELOG.md)
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/ankane/groupdate.sql/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/groupdate.sql/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features