Skip to content
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.

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

[docs](function) support aggregrate function regr_slope regr_intercept #1167

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Yoruet
Copy link

@Yoruet Yoruet commented Sep 29, 2024

Versions

  • dev
  • 3.0
  • 2.1
  • 2.0

Languages

  • Chinese
  • English

apache/doris#41240

@KassieZ KassieZ added the dependencies Pull requests that update a dependency file label Sep 30, 2024
@KassieZ
Copy link
Contributor

KassieZ commented Sep 30, 2024

hi, please update dev version as well

@KassieZ
Copy link
Contributor

KassieZ commented Sep 30, 2024

For SQL reference, please fix the title format, you could refer to this sample :


{
"title": "FUNCTION_NAME",
"language": "en"
}

Description

FUNCTION_NAME is used to XXXXXXX for XXXXX。(A brief description of the function and its purpose. Describe the use cases and scenarios where this function can be beneficial.)

Since Doris vXXX is supported XXXX。(Optional)

Syntax

FunctionName(param1, param2, ...)

Paremeters

  • param1 (DataType1): Brief description of the parameter and its role in the function.

  • param2 (DataType2): Same.

  • ...

Returned values

Returned data type: ReturnType

  • If XXXcase1 then returned XXXX value1;

  • If XXXXcase2 then returned XXXX value2;

Examples

-- Example 1: Basic Usage
SELECT FunctionName('example_value') FROM dummy_table;  
  
-- Example 2: Usage in query
SELECT column1, FunctionName(column2) AS result_column FROM example_table;  
  
-- Example 3: Advanced usage
SELECT column1, FunctionName(OTHER_FUNCTION(column2)) AS combined_result FROM example_table;

Usage notes

  • List any known limitations or restrictions on the usage of function.

  • This could include data size limits, unsupported data types, or specific behavior that may not be intuitive.

Related commands

FUNCTION_NAME_2FUNCTION_NAME_3More...

References

For more details about XXXX, please refere to XXXXX

@Yoruet
Copy link
Author

Yoruet commented Sep 30, 2024

hi, please update dev version as well

Sorry, I'm not sure what this means. I have added doc in version-3.0.

@KassieZ
Copy link
Contributor

KassieZ commented Sep 30, 2024

hi, please update dev version as well

Sorry, I'm not sure what this means. I have added doc in version-3.0.

Please also update EN docs on the directory : doris-website/doris-website/docs and CN docs on the directory : /doris-website/i18n/zh-CN/docusaurus-plugin-content-docs/current

@Yoruet
Copy link
Author

Yoruet commented Sep 30, 2024

hi, please update dev version as well

Sorry, I'm not sure what this means. I have added doc in version-3.0.

Please also update EN docs on the directory : doris-website/doris-website/docs and CN docs on the directory : /doris-website/i18n/zh-CN/docusaurus-plugin-content-docs/current

I have added docs:docs/sql-manual/sql-functions/aggregate-functions/regr_intercept.md , docs/sql-manual/sql-functions/aggregate-functions/regr_slope.md , i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-functions/aggregate-functions/regr_intercept.md, i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-functions/aggregate-functions/regr_slope.md

@KassieZ
Copy link
Contributor

KassieZ commented Dec 9, 2024

Thank you for the contribution, please also fix the conflicts.

@KassieZ KassieZ added Reviewed and removed Need update version-dev Need update version-3.0 dependencies Pull requests that update a dependency file labels Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something is incorrect Reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants