Skip to content

Conversation

@xuthus5
Copy link
Member

@xuthus5 xuthus5 commented Jul 26, 2024

In order to better understand and use APIs, we should have clear and simple API usage tutorials and tools to help users build their own applications. However, so far, the instructions for using the APIs ShowTagKeys, ShowTagValues, and ShowFieldKeys are vague, and users have no idea how to use the APIs. We need to inform users how to generate the command parameters of each API and what the return value means.

I have temporarily written comments for these APIs and created their builders to quickly generate simple query SQL.

@xuthus5
Copy link
Member Author

xuthus5 commented Jul 26, 2024

@Chenxulin97 @shoothzj PTAL, thanks.

@hezhangjian
Copy link
Member

Great work! I prefer ShowTagValues(database, TagValuesQuery tvq) ([]string, error) than ShowTagValues(database, command string) ([]string, error). WDYT?

@xuthus5 xuthus5 force-pushed the proposal/command_builder branch 2 times, most recently from 7c2420c to c654b26 Compare July 27, 2024 14:04
@xuthus5
Copy link
Member Author

xuthus5 commented Jul 27, 2024

The builder may not be perfect, but we can improve it based on requirements and issues.

CoulsonYing added a commit to CoulsonYing/opengemini-client-go that referenced this pull request Jul 28, 2024
@xuthus5 xuthus5 force-pushed the proposal/command_builder branch 5 times, most recently from 0997704 to 6321afd Compare September 5, 2024 18:11
@xuthus5 xuthus5 force-pushed the proposal/command_builder branch from 6321afd to 4e2c38a Compare September 5, 2024 18:36
@hezhangjian hezhangjian merged commit 3f56168 into openGemini:main Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants