3631388f75
This commit introduces the plumbing support for obtaining
classification information of a statement using the REST-API.
It introduces a URL like
/v1/maxscale/query_classifier/classify?sql=SELECT+1
that in the response will return a JSON object with the
information. Subsequent commits will provide the actual
information.
70 lines
1.8 KiB
C++
70 lines
1.8 KiB
C++
/*
|
|
* Copyright (c) 2018 MariaDB Corporation Ab
|
|
*
|
|
* Use of this software is governed by the Business Source License included
|
|
* in the LICENSE.TXT file and at www.mariadb.com/bsl11.
|
|
*
|
|
* Change Date: 2022-01-01
|
|
*
|
|
* On the date above, in accordance with the Business Source License, use
|
|
* of this software will be governed by version 2 or later of the General
|
|
* Public License.
|
|
*/
|
|
#pragma once
|
|
|
|
#include <maxscale/ccdefs.hh>
|
|
#include <maxscale/query_classifier.h>
|
|
#include <maxscale/jansson.hh>
|
|
|
|
MXS_BEGIN_DECLS
|
|
|
|
typedef enum qc_trx_parse_using
|
|
{
|
|
QC_TRX_PARSE_USING_QC, /**< Use the query classifier. */
|
|
QC_TRX_PARSE_USING_PARSER, /**< Use custom parser. */
|
|
} qc_trx_parse_using_t;
|
|
|
|
/**
|
|
* Returns the type bitmask of transaction related statements.
|
|
*
|
|
* @param stmt A COM_QUERY or COM_STMT_PREPARE packet.
|
|
* @param use What method should be used.
|
|
*
|
|
* @return The relevant type bits if the statement is transaction
|
|
* related, otherwise 0.
|
|
*
|
|
* @see qc_get_trx_type_mask
|
|
*/
|
|
uint32_t qc_get_trx_type_mask_using(GWBUF* stmt, qc_trx_parse_using_t use);
|
|
|
|
/**
|
|
* Common query classifier properties as JSON.
|
|
*
|
|
* @param zHost The MaxScale host.
|
|
*
|
|
* @return A json object containing properties.
|
|
*/
|
|
std::unique_ptr<json_t> qc_as_json(const char* zHost);
|
|
|
|
/**
|
|
* Alter common query classifier properties.
|
|
*
|
|
* @param pJson A JSON object.
|
|
*
|
|
* @return True, if the object was valid and parameters could be changed,
|
|
* false otherwise.
|
|
*/
|
|
bool qc_alter_from_json(json_t* pJson);
|
|
|
|
/**
|
|
* Classify statement
|
|
*
|
|
* @param zHost The MaxScale host.
|
|
* @param statement The statement to be classified.
|
|
*
|
|
* @return A json object containing information about the statement.
|
|
*/
|
|
std::unique_ptr<json_t> qc_classify_as_json(const char* zHost, const std::string& statement);
|
|
|
|
MXS_END_DECLS
|