Add SQrL EXPLAIN command #22
Conversation
mivasconcelos
commented
Mar 19, 2024
mivasconcelos
commented
| INKEEP_API_KEY = os.getenv('INKEEP_API_KEY') | ||
| INKEEP_INTEGRATION_ID = os.environ.get('INKEEP_INTEGRATION_ID') |
There was a problem hiding this comment.
this still need to be set up
|
|
||
| class SqrlExplain(SQLHandler): | ||
| """ | ||
| SQRL EXPLAIN string_value; |
There was a problem hiding this comment.
You should change string_value to something like query if a query string is expected here. This grammar is printed as part of the help information, so the more descriptive the labels are, the better.
| string_value = '<string-value>' | ||
|
|
||
| """ | ||
| INKEEP_API_KEY = os.getenv('INKEEP_API_KEY') |
There was a problem hiding this comment.
Use os.environ.get call for both of these.
| INKEEP_API_KEY = os.getenv('INKEEP_API_KEY') | ||
| INKEEP_INTEGRATION_ID = os.environ.get('INKEEP_INTEGRATION_ID') | ||
|
|
||
| def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]: |
There was a problem hiding this comment.
I'm wondering if the results should be returned as a result set rather than being printed. I don't know what the result will be used for, but printing is kind of a dead end since it just goes to stdout and it's hard to capture if needed.
|
|
||
| def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]: | ||
| prompt = "Explain me this SQL query:" + params['string_value'] | ||
| apiUrl = "https://api.inkeep.com/v0/chat_sessions/chat_results" |
There was a problem hiding this comment.
I think this should be a class variable as well so it can be changed easier for testing new API versions.
|
|
||
| def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]: | ||
| prompt = "Explain me this SQL query:" + params['string_value'] | ||
| apiUrl = "https://api.inkeep.com/v0/chat_sessions/chat_results" |
There was a problem hiding this comment.
Use PEP-8 style variable names: api_url.
| apiUrl, | ||
| headers={ | ||
| 'Content-Type': 'application/json', | ||
| 'Authorization': 'Bearer ' + INKEEP_API_KEY, |
There was a problem hiding this comment.
This should be self.INKEEP_API_KEY, correct?
| 'Authorization': 'Bearer ' + INKEEP_API_KEY, | ||
| }, | ||
| json={ | ||
| "integration_id": INKEEP_INTEGRATION_ID, |
| INKEEP_INTEGRATION_ID = os.environ.get('INKEEP_INTEGRATION_ID') | ||
|
|
||
| def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]: | ||
| prompt = "Explain me this SQL query:" + params['string_value'] |
There was a problem hiding this comment.
Add a check here to make sure the API keys are not None. If they are, print a message to stderr that they need to be set to use this command.
