session_settings.h

#pragma once
/*
 * Copyright 2010-2019, Tarantool AUTHORS, please see AUTHORS file.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1. Redistributions of source code must retain the above
 *    copyright notice, this list of conditions and the
 *    following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials
 *    provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * <COPYRIGHT HOLDER> OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include "field_def.h"

/**
 * Identifiers of all session settings. The identifier of the
 * option is equal to its place in the sorted list of session
 * options.
 *
 * It is IMPORTANT that these options are sorted by name. If this
 * is not the case, the result returned by the _session_settings
 * space iterator will not be sorted properly.
 */
enum {
	SESSION_SETTING_SQL_BEGIN,
	SESSION_SETTING_SQL_DEFAULT_ENGINE = SESSION_SETTING_SQL_BEGIN,
	SESSION_SETTING_SQL_FULL_COLUMN_NAMES,
	SESSION_SETTING_SQL_FULL_METADATA,
	SESSION_SETTING_SQL_PARSER_DEBUG,
	SESSION_SETTING_SQL_RECURSIVE_TRIGGERS,
	SESSION_SETTING_SQL_REVERSE_UNORDERED_SELECTS,
	SESSION_SETTING_SQL_SELECT_DEBUG,
	SESSION_SETTING_SQL_SEQ_SCAN,
	SESSION_SETTING_SQL_VDBE_DEBUG,
	SESSION_SETTING_SQL_END,
	/**
	 * Follow the pattern for groups of settings:
	 * SESSION_SETTING_<N>_BEGIN = SESSION_SETTING_<N-1>_END,
	 * ...
	 * SESSION_SETTING_<N>_END,
	 */
	SESSION_SETTING_COUNT = SESSION_SETTING_SQL_END,
};

struct session_setting {
	/**
	 * Setting's value type. Used for error checking and
	 * reporting only.
	 */
	enum field_type field_type;
	/**
	 * Get a MessagePack encoded pair [name, value] for a
	 * setting having index @a id. Index is from the settings
	 * array.
	 */
	void (*get)(int id, const char **mp_pair, const char **mp_pair_end);
	/**
	 * Set value of a setting by a given @a id from a
	 * MessagePack encoded buffer. Note, it is not a pair, but
	 * just value.
	 */
	int (*set)(int id, const char *mp_value);
};

extern struct session_setting session_settings[SESSION_SETTING_COUNT];
extern const char *session_setting_strs[SESSION_SETTING_COUNT];

int
session_setting_find(const char *name);