fix the document of TO_DATE, TO_DAYS, year_floor, WEEKS_ADD, WEEKS_DIFF, WEEKS_SUB function #2197
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
morrySnow
reviewed
Mar 17, 2025
Comment on lines
36
to
37
| ## Required parameter | ||
| **datetime_value**: datetime type datetime |
There was a problem hiding this comment.
function doc's parameter should put into a table.
|
|
||
| The difference between the start time and the end time is weeks | ||
| ```sql | ||
| WEEKS_DIFF([<end_date> | <end_datetime>], [<start_date> | <start_datetime>]) |
There was a problem hiding this comment.
Suggested change
| WEEKS_DIFF([<end_date> | <end_datetime>], [<start_date> | <start_datetime>]) | |
| WEEKS_DIFF(<end_date> <start_date>) |
|
|
||
| ### example | ||
| ## Optional parameters |
There was a problem hiding this comment.
Suggested change
| ## Optional parameters | |
| ## Parameters |
Comment on lines
39
to
42
| | **`end_date`** | `DATE` | Later date | | ||
| | **`end_datetime`** | `DATETIME` | Later datetime | | ||
| | **`start_date`** | `DATE` | Earlier date | | ||
| | **`start_datetime`** | `DATETIME` | Earlier datetime | |
There was a problem hiding this comment.
在这里解释一下可以处理 date / datetime 就可以了
| ## Description | ||
| ## Syntax | ||
| ```sql | ||
| WEEKS_SUB([<date_value> | <datetime_value>], <week_period>) |
There was a problem hiding this comment.
Suggested change
| WEEKS_SUB([<date_value> | <datetime_value>], <week_period>) | |
| WEEKS_SUB(<date_value>, <week_period>) |
Comment on lines
34
to
44
| ## Required parameters | ||
| **<week_period>** | ||
| > Integer representing the number of weeks to be reduced (positive number means reduction, negative number means increase). | ||
|
|
||
| The parameter date can be DATETIME or DATE, and the return type is consistent with that of the parameter date. | ||
| ## Optional parameters | ||
| - **<date_value>** | ||
| > Date input value of type `DATE` | ||
|
|
||
| ### example | ||
| - **<datetime_value>** | ||
| > Date and time input value of type `DATETIME` | ||
|
|
|
|
||
| `DATETIME WEEKS_SUB(DATETIME date, INT weeks)` | ||
| ## Description |
| - period: specifies how many years each cycle consists of. | ||
| - origin: starting from 0001-01-01T00:00:00. | ||
| ```sql | ||
| YEAR_FLOOR([<datetime_value> | <date_value>]) | |
There was a problem hiding this comment.
datetime 和 date 就用一个参数表示就可以，在参数说明章节，说清楚可以是date 或者 datetime 就好了
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Versions
Languages
Docs Checklist