MySQL 8.3.0
Source Code Documentation
Item_func_geomfromgeojson Class Reference

This handles one function: More...

#include <item_geofunc.h>

Inheritance diagram for Item_func_geomfromgeojson:
[legend]

Public Types

enum  enum_handle_coordinate_dimension { reject_document , strip_now_accept_future , strip_now_reject_future , strip_now_strip_future }
 Describing how coordinate dimensions higher than supported in MySQL should be handled. More...
 
- Public Types inherited from Item_func
enum  Functype {
  UNKNOWN_FUNC , EQ_FUNC , EQUAL_FUNC , NE_FUNC ,
  LT_FUNC , LE_FUNC , GE_FUNC , GT_FUNC ,
  FT_FUNC , MATCH_FUNC , LIKE_FUNC , ISNULL_FUNC ,
  ISNOTNULL_FUNC , ISTRUTH_FUNC , COND_AND_FUNC , COND_OR_FUNC ,
  XOR_FUNC , BETWEEN , IN_FUNC , MULT_EQUAL_FUNC ,
  INTERVAL_FUNC , ISNOTNULLTEST_FUNC , SP_EQUALS_FUNC , SP_DISJOINT_FUNC ,
  SP_DISTANCE_FUNC , SP_INTERSECTS_FUNC , SP_TOUCHES_FUNC , SP_CROSSES_FUNC ,
  SP_WITHIN_FUNC , SP_CONTAINS_FUNC , SP_COVEREDBY_FUNC , SP_COVERS_FUNC ,
  SP_OVERLAPS_FUNC , SP_STARTPOINT , SP_ENDPOINT , SP_EXTERIORRING ,
  SP_POINTN , SP_GEOMETRYN , SP_INTERIORRINGN , NOT_FUNC ,
  NOT_ALL_FUNC , NOW_FUNC , FROM_DAYS_FUNC , TRIG_COND_FUNC ,
  SUSERVAR_FUNC , GUSERVAR_FUNC , COLLATE_FUNC , EXTRACT_FUNC ,
  TYPECAST_FUNC , FUNC_SP , UDF_FUNC , NEG_FUNC ,
  GSYSVAR_FUNC , GROUPING_FUNC , ROLLUP_GROUP_ITEM_FUNC , TABLE_FUNC ,
  DD_INTERNAL_FUNC , PLUS_FUNC , MINUS_FUNC , MUL_FUNC ,
  DIV_FUNC , CEILING_FUNC , ROUND_FUNC , TRUNCATE_FUNC ,
  SQRT_FUNC , ABS_FUNC , POW_FUNC , SIGN_FUNC ,
  FLOOR_FUNC , LOG_FUNC , LN_FUNC , LOG10_FUNC ,
  SIN_FUNC , TAN_FUNC , COS_FUNC , COT_FUNC ,
  DEGREES_FUNC , RADIANS_FUNC , EXP_FUNC , ASIN_FUNC ,
  ATAN_FUNC , ACOS_FUNC , MOD_FUNC , IF_FUNC ,
  NULLIF_FUNC , CASE_FUNC , YEAR_FUNC , YEARWEEK_FUNC ,
  MAKEDATE_FUNC , MAKETIME_FUNC , MONTH_FUNC , MONTHNAME_FUNC ,
  DAY_FUNC , DAYNAME_FUNC , TO_DAYS_FUNC , TO_SECONDS_FUNC ,
  DATE_FUNC , HOUR_FUNC , MINUTE_FUNC , SECOND_FUNC ,
  MICROSECOND_FUNC , DAYOFYEAR_FUNC , ADDTIME_FUNC , QUARTER_FUNC ,
  WEEK_FUNC , WEEKDAY_FUNC , DATEADD_FUNC , FROM_UNIXTIME_FUNC ,
  CONVERT_TZ_FUNC , LAST_DAY_FUNC , UNIX_TIMESTAMP_FUNC , TIME_TO_SEC_FUNC ,
  TIMESTAMPDIFF_FUNC , DATETIME_LITERAL , GREATEST_FUNC , COALESCE_FUNC ,
  LEAST_FUNC , JSON_CONTAINS , JSON_OVERLAPS , JSON_UNQUOTE_FUNC ,
  MEMBER_OF_FUNC , STRCMP_FUNC , TRUE_FUNC , FALSE_FUNC ,
  SYSDATE_FUNC , TIMEDIFF_FUNC , PERIODADD_FUNC , PERIODDIFF_FUNC ,
  SEC_TO_TIME_FUNC , GET_FORMAT_FUNC , ANY_VALUE_FUNC , JSON_LENGTH_FUNC ,
  JSON_DEPTH_FUNC , JSON_EXTRACT_FUNC , JSON_OBJECT_FUNC , JSON_ARRAY_FUNC
}
 
enum  optimize_type {
  OPTIMIZE_NONE , OPTIMIZE_KEY , OPTIMIZE_OP , OPTIMIZE_NULL ,
  OPTIMIZE_EQUAL
}
 
- Public Types inherited from Item
enum  Type {
  INVALID_ITEM = 0 , FIELD_ITEM , FUNC_ITEM , SUM_FUNC_ITEM ,
  STRING_ITEM , INT_ITEM , REAL_ITEM , NULL_ITEM ,
  VARBIN_ITEM , METADATA_COPY_ITEM , FIELD_AVG_ITEM , DEFAULT_VALUE_ITEM ,
  PROC_ITEM , COND_ITEM , REF_ITEM , FIELD_STD_ITEM ,
  FIELD_VARIANCE_ITEM , INSERT_VALUE_ITEM , SUBSELECT_ITEM , ROW_ITEM ,
  CACHE_ITEM , TYPE_HOLDER , PARAM_ITEM , TRIGGER_FIELD_ITEM ,
  DECIMAL_ITEM , XPATH_NODESET , XPATH_NODESET_CMP , VIEW_FIXER_ITEM ,
  FIELD_BIT_ITEM , VALUES_COLUMN_ITEM
}
 
enum  cond_result { COND_UNDEF , COND_OK , COND_TRUE , COND_FALSE }
 
enum  traverse_order { POSTFIX , PREFIX }
 
enum  enum_const_item_cache { CACHE_NONE = 0 , CACHE_JSON_VALUE , CACHE_JSON_ATOM }
 How to cache constant JSON data. More...
 
enum  Bool_test {
  BOOL_IS_TRUE = 0x00 , BOOL_IS_FALSE = 0x01 , BOOL_IS_UNKNOWN = 0x02 , BOOL_NOT_TRUE = 0x03 ,
  BOOL_NOT_FALSE = 0x04 , BOOL_NOT_UNKNOWN = 0x05 , BOOL_IDENTITY = 0x06 , BOOL_NEGATED = 0x07 ,
  BOOL_ALWAYS_TRUE = 0x08 , BOOL_ALWAYS_FALSE = 0x09
}
 < Modifier for result transformation More...
 
enum  item_marker {
  MARKER_NONE = 0 , MARKER_IMPLICIT_NE_ZERO = 1 , MARKER_CONST_PROPAG = 2 , MARKER_BIT = 4 ,
  MARKER_FUNC_DEP_NOT_NULL = 5 , MARKER_DISTINCT_GROUP = 6 , MARKER_COND_DERIVED_TABLE = 7 , MARKER_TRAVERSAL = 8 ,
  MARKER_ICP_COND_USES_INDEX_ONLY = 10
}
 < Values for member 'marker' More...
 
- Public Types inherited from Parse_tree_node_tmpl< Context >
typedef Context context_t
 

Public Member Functions

 Item_func_geomfromgeojson (const POS &pos, Item *json_string)
 
 Item_func_geomfromgeojson (const POS &pos, Item *json_string, Item *options)
 
 Item_func_geomfromgeojson (const POS &pos, Item *json_string, Item *options, Item *srid)
 
Stringval_str (String *) override
 <geometry> = ST_GEOMFROMGEOJSON(<string>[, <options>[, <srid>]]) More...
 
bool fix_fields (THD *, Item **ref) override
 Do type checking on all provided arguments. More...
 
const char * func_name () const override
 
Geometry::wkbType get_wkbtype (const char *typestring)
 Converts GeoJSON type string to a wkbType. More...
 
bool get_positions (const Json_array *coordinates, Gis_point *point)
 Parse an array of coordinates to a Gis_point. More...
 
bool get_linestring (const Json_array *data_array, Gis_line_string *linestring)
 Create a Gis_line_string from a JSON array. More...
 
bool get_polygon (const Json_array *data_array, Gis_polygon *polygon)
 Create a Gis_polygon from a JSON array. More...
 
bool parse_object (const Json_object *object, bool *rollback, String *buffer, bool is_parent_featurecollection, Geometry **geometry)
 Takes a JSON object as input, and parses the data to a Geometry object. More...
 
bool parse_object_array (const Json_array *points, Geometry::wkbType type, bool *rollback, String *buffer, bool is_parent_featurecollection, Geometry **geometry)
 Takes a JSON array as input, does a recursive parsing and returns a Geometry object. More...
 
bool parse_crs_object (const Json_object *crs_object)
 Takes a GeoJSON CRS object as input and parses it into a SRID. More...
 
bool is_member_valid (const Json_dom *member, const char *member_name, enum_json_type expected_type, bool allow_null, bool *was_null)
 Checks if a JSON member is valid based on input criteria. More...
 
const Json_dommy_find_member_ncase (const Json_object *object, const char *member_name)
 Case insensitive lookup of a member in a JSON object. More...
 
- Public Member Functions inherited from Item_geometry_func
 Item_geometry_func ()
 
 Item_geometry_func (Item *a)
 
 Item_geometry_func (const POS &pos, Item *a)
 
 Item_geometry_func (Item *a, Item *b)
 
 Item_geometry_func (const POS &pos, Item *a, Item *b)
 
 Item_geometry_func (Item *a, Item *b, Item *c)
 
 Item_geometry_func (const POS &pos, Item *a, Item *b, Item *c)
 
 Item_geometry_func (const POS &pos, PT_item_list *list)
 
bool resolve_type (THD *) override
 Resolve type-related information for this item, such as result field type, maximum size, precision, signedness, character set and collation. More...
 
Fieldtmp_table_field (TABLE *t_arg) override
 
- Public Member Functions inherited from Item_str_func
 Item_str_func ()
 
 Item_str_func (const POS &pos)
 
 Item_str_func (Item *a)
 
 Item_str_func (const POS &pos, Item *a)
 
 Item_str_func (Item *a, Item *b)
 
 Item_str_func (const POS &pos, Item *a, Item *b)
 
 Item_str_func (Item *a, Item *b, Item *c)
 
 Item_str_func (const POS &pos, Item *a, Item *b, Item *c)
 
 Item_str_func (Item *a, Item *b, Item *c, Item *d)
 
 Item_str_func (const POS &pos, Item *a, Item *b, Item *c, Item *d)
 
 Item_str_func (Item *a, Item *b, Item *c, Item *d, Item *e)
 
 Item_str_func (const POS &pos, Item *a, Item *b, Item *c, Item *d, Item *e)
 
 Item_str_func (const POS &pos, Item *a, Item *b, Item *c, Item *d, Item *e, Item *f)
 
 Item_str_func (mem_root_deque< Item * > *list)
 
 Item_str_func (const POS &pos, PT_item_list *opt_list)
 
longlong val_int () override
 
double val_real () override
 
my_decimalval_decimal (my_decimal *) override
 
bool get_date (MYSQL_TIME *ltime, my_time_flags_t fuzzydate) override
 
bool get_time (MYSQL_TIME *ltime) override
 
enum Item_result result_type () const override
 
void left_right_max_length (THD *thd)
 
bool fix_fields (THD *thd, Item **ref) override
 
bool resolve_type (THD *thd) override
 Resolve type-related information for this item, such as result field type, maximum size, precision, signedness, character set and collation. More...
 
Stringval_str_from_val_str_ascii (String *str, String *str2)
 
- Public Member Functions inherited from Item_func
virtual uint argument_count () const
 
Item ** arguments () const
 
enum Type type () const override
 
virtual enum Functype functype () const
 
 Item_func ()
 
 Item_func (const POS &pos)
 
 Item_func (Item *a)
 
 Item_func (const POS &pos, Item *a)
 
 Item_func (Item *a, Item *b)
 
 Item_func (const POS &pos, Item *a, Item *b)
 
 Item_func (Item *a, Item *b, Item *c)
 
 Item_func (const POS &pos, Item *a, Item *b, Item *c)
 
 Item_func (Item *a, Item *b, Item *c, Item *d)
 
 Item_func (const POS &pos, Item *a, Item *b, Item *c, Item *d)
 
 Item_func (Item *a, Item *b, Item *c, Item *d, Item *e)
 
 Item_func (const POS &pos, Item *a, Item *b, Item *c, Item *d, Item *e)
 
 Item_func (Item *a, Item *b, Item *c, Item *d, Item *e, Item *f)
 
 Item_func (const POS &pos, Item *a, Item *b, Item *c, Item *d, Item *e, Item *f)
 
 Item_func (mem_root_deque< Item * > *list)
 
 Item_func (const POS &pos, PT_item_list *opt_list)
 
 Item_func (THD *thd, const Item_func *item)
 
virtual Itemget_arg (uint i)
 Get the i'th argument of the function that this object represents. More...
 
virtual const Itemget_arg (uint i) const
 Get the i'th argument of the function that this object represents. More...
 
virtual Itemset_arg (THD *, uint, Item *)
 
bool do_itemize (Parse_context *pc, Item **res) override
 The core function that does the actual itemization. More...
 
bool fix_func_arg (THD *, Item **arg)
 
void fix_after_pullout (Query_block *parent_query_block, Query_block *removed_query_block) override
 Fix after tables have been moved from one query_block level to the parent level, e.g by semijoin conversion. More...
 
virtual bool resolve_type_inner (THD *)
 Resolve type of function after all arguments have had their data types resolved. More...
 
bool propagate_type (THD *thd, const Type_properties &type) override
 Default implementation for all functions: Propagate base_item's type into all arguments. More...
 
virtual table_map get_initial_pseudo_tables () const
 Returns the pseudo tables depended upon in order to evaluate this function expression. More...
 
table_map used_tables () const override
 
table_map not_null_tables () const override
 Return table map of tables that can't be NULL tables (tables that are used in a context where if they would contain a NULL row generated by a LEFT or RIGHT join, the item would not be true). More...
 
void update_used_tables () override
 Updates used tables, not null tables information and accumulates properties up the item tree, cf. More...
 
void set_used_tables (table_map map)
 
bool eq (const Item *item, bool binary_cmp) const override
 
virtual optimize_type select_optimize (const THD *)
 
virtual bool have_rev_func () const
 
virtual Itemkey_item () const
 
bool set_arguments (mem_root_deque< Item * > *list, bool context_free)
 Copy arguments from list to args array. More...
 
bool split_sum_func (THD *thd, Ref_item_array ref_item_array, mem_root_deque< Item * > *fields) override
 See comments in Item_cmp_func::split_sum_func() More...
 
void print (const THD *thd, String *str, enum_query_type query_type) const override
 This method is used for to: More...
 
void print_op (const THD *thd, String *str, enum_query_type query_type) const
 
void print_args (const THD *thd, String *str, uint from, enum_query_type query_type) const
 
virtual void fix_num_length_and_dec ()
 
virtual bool is_deprecated () const
 
bool get_arg0_date (MYSQL_TIME *ltime, my_time_flags_t fuzzy_date)
 
bool get_arg0_time (MYSQL_TIME *ltime)
 
bool is_null () override
 The method allows to determine nullness of a complex expression without fully evaluating it, instead of calling val*() then checking null_value. More...
 
void signal_divide_by_null ()
 
void signal_invalid_argument_for_log ()
 
Itemget_tmp_table_item (THD *thd) override
 If an Item is materialized in a temporary table, a different Item may have to be used in the part of the query that runs after the materialization. More...
 
bool agg_arg_charsets (DTCollation &c, Item **items, uint nitems, uint flags, int item_sep)
 
bool agg_arg_charsets_for_string_result (DTCollation &c, Item **items, uint nitems, int item_sep=1)
 
bool agg_arg_charsets_for_comparison (DTCollation &c, Item **items, uint nitems, int item_sep=1)
 
bool walk (Item_processor processor, enum_walk walk, uchar *arg) override
 Traverses a tree of Items in prefix and/or postfix order. More...
 
Itemtransform (Item_transformer transformer, uchar *arg) override
 Transform an Item_func object with a transformer callback function. More...
 
Itemcompile (Item_analyzer analyzer, uchar **arg_p, Item_transformer transformer, uchar *arg_t) override
 Compile Item_func object with a processor and a transformer callback functions. More...
 
void traverse_cond (Cond_traverser traverser, void *arg, traverse_order order) override
 
bool replace_equal_field_checker (uchar **arg) override
 
Itemreplace_equal_field (uchar *arg) override
 
virtual bool allow_replacement (Item_field *const original, Item_field *const subst)
 Check whether a function allows replacement of a field with another: In particular, a replacement that changes the metadata of some Item from non-nullable to nullable is not allowed. More...
 
double check_float_overflow (double value)
 Throw an error if the input double number is not finite, i.e. More...
 
longlong check_integer_overflow (longlong value, bool val_unsigned)
 Throw an error if the input BIGINT value represented by the (longlong value, bool unsigned flag) pair cannot be returned by the function, i.e. More...
 
int check_decimal_overflow (int error)
 Throw an error if the error code of a DECIMAL operation is E_DEC_OVERFLOW. More...
 
bool has_timestamp_args ()
 
bool has_date_args ()
 
bool has_time_args ()
 
bool has_datetime_args ()
 
bool check_valid_arguments_processor (uchar *) override
 
Itemgc_subst_transformer (uchar *arg) override
 Transformer function for GC substitution. More...
 
virtual enum_const_item_cache can_cache_json_arg (Item *arg)
 Whether an arg of a JSON function can be cached to avoid repetitive string->JSON conversion. More...
 
virtual bool contains_only_equi_join_condition () const
 Whether this Item is an equi-join condition. More...
 
- Public Member Functions inherited from Item_result_field
 Item_result_field ()=default
 
 Item_result_field (const POS &pos)
 
 Item_result_field (THD *thd, const Item_result_field *item)
 
Fieldget_tmp_table_field () override
 If this Item is being materialized into a temporary table, returns the field that is being materialized into. More...
 
void set_result_field (Field *field) override
 
bool is_result_field () const override
 
Fieldget_result_field () const override
 
void cleanup () override
 Called for every Item after use (preparation and execution). More...
 
bool mark_field_in_map (uchar *arg) override
 Mark underlying field in read or write map of a table. More...
 
longlong llrint_with_overflow_check (double realval)
 
void raise_numeric_overflow (const char *type_name)
 
double raise_float_overflow ()
 
longlong raise_integer_overflow ()
 
int raise_decimal_overflow ()
 
- Public Member Functions inherited from Item
 Item (const Item &)=delete
 
void operator= (Item &)=delete
 
 Item ()
 Item constructor for general use. More...
 
 Item (THD *thd, const Item *item)
 Constructor used by Item_field, Item_ref & aggregate functions. More...
 
 Item (const POS &)
 Parse-time context-independent constructor. More...
 
 ~Item () override=default
 
virtual bool itemize (Parse_context *pc, Item **res) final
 The same as contextualize() but with additional parameter. More...
 
void rename (char *new_name)
 rename item (used for views, cleanup() return original name). More...
 
void init_make_field (Send_field *tmp_field, enum enum_field_types type)
 
virtual void notify_removal ()
 Called when an item has been removed, can be used to notify external objects about the removal, e.g subquery predicates that are part of the sj_candidates container. More...
 
virtual void make_field (Send_field *field)
 
virtual Fieldmake_string_field (TABLE *table) const
 Create a field to hold a string value from an item. More...
 
void quick_fix_field ()
 
virtual void set_can_use_prefix_key ()
 
bool propagate_type (THD *thd, enum_field_types def=MYSQL_TYPE_VARCHAR, bool pin=false, bool inherit=false)
 Wrapper for easier calling of propagate_type(const Type_properties &). More...
 
virtual void mark_json_as_scalar ()
 For Items with data type JSON, mark that a string argument is treated as a scalar JSON value. More...
 
virtual std::optional< ContainedSubqueryget_contained_subquery (const Query_block *outer_query_block)
 If this item represents a IN/ALL/ANY/comparison_operator subquery, return that (along with data on how it will be executed). More...
 
type_conversion_status save_in_field_no_warnings (Field *field, bool no_conversions)
 Save the item into a field but do not emit any warnings. More...
 
type_conversion_status save_in_field (Field *field, bool no_conversions)
 Save a temporal value in packed longlong format into a Field. More...
 
void save_in_field_no_error_check (Field *field, bool no_conversions)
 A slightly faster value of save_in_field() that returns no error value (you will need to check thd->is_error() yourself), and does not support saving into hidden fields for functional indexes. More...
 
virtual void save_org_in_field (Field *field)
 
virtual bool send (Protocol *protocol, String *str)
 This is only called from items that is not of type item_field. More...
 
bool evaluate (THD *thd, String *str)
 Evaluate scalar item, possibly using the supplied buffer. More...
 
virtual Item_result numeric_context_result_type () const
 Result type when an item appear in a numeric context. More...
 
Item_result temporal_with_date_as_number_result_type () const
 Similar to result_type() but makes DATE, DATETIME, TIMESTAMP pretend to be numbers rather than strings. More...
 
virtual void set_data_type_inherited ()
 Set data type for item as inherited. More...
 
virtual void pin_data_type ()
 Pin the data type for the item. More...
 
enum_field_types data_type () const
 Retrieve the derived data type of the Item. More...
 
virtual enum_field_types actual_data_type () const
 Retrieve actual data type for an item. More...
 
virtual enum_field_types default_data_type () const
 Get the default data (output) type for the specific item. More...
 
void set_data_type (enum_field_types data_type)
 Set the data type of the current Item. More...
 
void set_data_type_null ()
 
void set_data_type_bool ()
 
void set_data_type_int (enum_field_types type, bool unsigned_prop, uint32 max_width)
 Set the data type of the Item to be a specific integer type. More...
 
void set_data_type_longlong ()
 Set the data type of the Item to be longlong. More...
 
void set_data_type_decimal (uint8 precision, uint8 scale)
 Set the data type of the Item to be decimal. More...
 
void set_data_type_double ()
 Set the data type of the Item to be double precision floating point. More...
 
void set_data_type_float ()
 Set the data type of the Item to be single precision floating point. More...
 
void set_data_type_string (uint32 max_l)
 Set the Item to be variable length string. More...
 
void set_data_type_string (ulonglong max_char_length_arg)
 Set the Item to be variable length string. More...
 
void set_data_type_string (uint32 max_l, const CHARSET_INFO *cs)
 Set the Item to be variable length string. More...
 
void set_data_type_string (uint32 max_l, const DTCollation &coll)
 Set the Item to be variable length string. More...
 
void set_data_type_char (uint32 max_l)
 Set the Item to be fixed length string. More...
 
void set_data_type_char (uint32 max_l, const CHARSET_INFO *cs)
 Set the Item to be fixed length string. More...
 
void set_data_type_blob (enum_field_types type, uint32 max_l)
 Set the Item to be of BLOB type. More...
 
void set_data_type_date ()
 Set all type properties for Item of DATE type. More...
 
void set_data_type_time (uint8 fsp)
 Set all type properties for Item of TIME type. More...
 
void set_data_type_datetime (uint8 fsp)
 Set all properties for Item of DATETIME type. More...
 
void set_data_type_timestamp (uint8 fsp)
 Set all properties for Item of TIMESTAMP type. More...
 
void set_data_type_geometry ()
 Set the data type of the Item to be GEOMETRY. More...
 
void set_data_type_json ()
 Set the data type of the Item to be JSON. More...
 
void set_data_type_year ()
 Set the data type of the Item to be YEAR. More...
 
void set_data_type_bit (uint32 max_bits)
 Set the data type of the Item to be bit. More...
 
void set_data_type_from_item (const Item *item)
 Set data type properties of the item from the properties of another item. More...
 
virtual TYPELIBget_typelib () const
 Get the typelib information for an item of type set or enum. More...
 
virtual Item_result cast_to_int_type () const
 
bool aggregate_type (const char *name, Item **items, uint count)
 Aggregates data types from array of items into current item. More...
 
virtual enum_monotonicity_info get_monotonicity_info () const
 
virtual longlong val_int_endpoint (bool left_endp, bool *incl_endp)
 
virtual longlong val_date_temporal ()
 Return date value of item in packed longlong format. More...
 
virtual longlong val_time_temporal ()
 Return time value of item in packed longlong format. More...
 
longlong val_temporal_by_field_type ()
 Return date or time value of item in packed longlong format, depending on item field type. More...
 
longlong int_sort_key ()
 Produces a key suitable for filesort. More...
 
longlong val_temporal_with_round (enum_field_types type, uint8 dec)
 Get date or time value in packed longlong format. More...
 
ulonglong val_uint ()
 
virtual Stringval_str_ascii (String *str)
 
virtual bool val_bool ()
 
virtual bool val_json (Json_wrapper *result)
 Get a JSON value from an Item. More...
 
virtual float get_filtering_effect (THD *thd, table_map filter_for_table, table_map read_tables, const MY_BITMAP *fields_to_ignore, double rows_in_table)
 Calculate the filter contribution that is relevant for table 'filter_for_table' for this item. More...
 
bool error_json ()
 Get the value to return from val_json() in case of errors. More...
 
bool get_date_from_non_temporal (MYSQL_TIME *ltime, my_time_flags_t fuzzydate)
 Convert a non-temporal type to date. More...
 
bool get_time_from_non_temporal (MYSQL_TIME *ltime)
 Convert a non-temporal type to time. More...
 
my_decimalerror_decimal (my_decimal *decimal_value)
 Get the value to return from val_decimal() in case of errors. More...
 
Stringerror_str ()
 Get the value to return from val_str() in case of errors. More...
 
type_conversion_status save_time_in_field (Field *field)
 
type_conversion_status save_date_in_field (Field *field)
 
type_conversion_status save_str_value_in_field (Field *field, String *result)
 
virtual const char * full_name () const
 
virtual bool basic_const_item () const
 Returns true if this is a simple constant item like an integer, not a constant expression. More...
 
bool may_eval_const_item (const THD *thd) const
 
virtual Itemclone_item () const
 
virtual cond_result eq_cmp_result () const
 
uint float_length (uint decimals_par) const
 
virtual uint decimal_precision () const
 
int decimal_int_part () const
 
virtual uint time_precision ()
 TIME precision of the item: 0..6. More...
 
virtual uint datetime_precision ()
 DATETIME precision of the item: 0..6. More...
 
bool const_item () const
 Returns true if item is constant, regardless of query evaluation state. More...
 
bool const_for_execution () const
 Returns true if item is constant during one query execution. More...
 
bool may_evaluate_const (const THD *thd) const
 Return true if this is a const item that may be evaluated in the current phase of statement processing. More...
 
bool is_non_deterministic () const
 
bool is_outer_reference () const
 
void print_item_w_name (const THD *thd, String *, enum_query_type query_type) const
 
void print_for_order (const THD *thd, String *str, enum_query_type query_type, const char *used_alias) const
 Prints the item when it's part of ORDER BY and GROUP BY. More...
 
bool split_sum_func2 (THD *thd, Ref_item_array ref_item_array, mem_root_deque< Item * > *fields, Item **ref, bool skip_registered)
 
virtual bool get_timeval (my_timeval *tm, int *warnings)
 Get timestamp in "struct timeval" format. More...
 
bool update_null_value ()
 Make sure the null_value member has a correct value. More...
 
virtual void apply_is_true ()
 Apply the IS TRUE truth property, meaning that an UNKNOWN result and a FALSE result are treated the same. More...
 
virtual bool is_bool_func () const
 
virtual void no_rows_in_result ()
 
virtual Itemcopy_or_same (THD *)
 
virtual Itemcopy_andor_structure (THD *)
 
virtual Itemreal_item ()
 
virtual const Itemreal_item () const
 
virtual const CHARSET_INFOcompare_collation () const
 
virtual const CHARSET_INFOcharset_for_protocol ()
 
template<class T >
auto walk_helper_thunk (uchar *arg)
 
template<class T >
auto analyze_helper_thunk (uchar **arg)
 See CompileItem. More...
 
virtual bool intro_version (uchar *)
 
bool cleanup_processor (uchar *)
 cleanup() item if it is resolved ('fixed'). More...
 
virtual bool collect_item_field_processor (uchar *)
 
virtual bool collect_item_field_or_ref_processor (uchar *)
 
virtual bool collect_item_field_or_view_ref_processor (uchar *)
 Collects fields and view references that have the qualifying table in the specified query block. More...
 
virtual bool add_field_to_set_processor (uchar *)
 Item::walk function. More...
 
virtual bool visitor_processor (uchar *arg)
 A processor to handle the select lex visitor framework. More...
 
virtual bool add_field_to_cond_set_processor (uchar *)
 Item::walk function. More...
 
virtual bool remove_column_from_bitmap (uchar *arg)
 Visitor interface for removing all column expressions (Item_field) in this expression tree from a bitmap. More...
 
virtual bool find_item_in_field_list_processor (uchar *)
 
virtual bool change_context_processor (uchar *)
 
virtual bool find_item_processor (uchar *arg)
 
virtual bool find_field_processor (uchar *)
 Is this an Item_field which references the given Field argument? More...
 
virtual bool cast_incompatible_args (uchar *)
 Wrap incompatible arguments in CAST nodes to the expected data types. More...
 
virtual bool reset_wf_state (uchar *arg)
 Reset execution state for such window function types as determined by arg. More...
 
virtual bool used_tables_for_level (uchar *arg)
 Return used table information for the specified query block (level). More...
 
virtual bool check_column_privileges (uchar *thd)
 Check privileges. More...
 
virtual bool inform_item_in_cond_of_tab (uchar *)
 
virtual void bind_fields ()
 Bind objects from the current execution context to field objects in item trees. More...
 
virtual bool clean_up_after_removal (uchar *arg)
 Clean up after removing the item from the item tree. More...
 
virtual bool aggregate_check_distinct (uchar *)
 
virtual bool aggregate_check_group (uchar *)
 
virtual bool is_strong_side_column_not_in_fd (uchar *)
 
virtual bool is_column_not_in_fd (uchar *)
 
virtual Bool3 local_column (const Query_block *) const
 
virtual bool collect_scalar_subqueries (uchar *)
 
virtual bool collect_grouped_aggregates (uchar *)
 
virtual bool collect_subqueries (uchar *)
 
virtual bool update_depended_from (uchar *)
 
virtual bool has_aggregate_ref_in_group_by (uchar *)
 Check if an aggregate is referenced from within the GROUP BY clause of the query block in which it is aggregated. More...
 
bool visit_all_analyzer (uchar **)
 
virtual bool cache_const_expr_analyzer (uchar **cache_item)
 Check if an item is a constant one and can be cached. More...
 
Itemcache_const_expr_transformer (uchar *item)
 Cache item if needed. More...
 
virtual bool equality_substitution_analyzer (uchar **)
 
virtual Itemequality_substitution_transformer (uchar *)
 
virtual bool check_partition_func_processor (uchar *)
 Check if a partition function is allowed. More...
 
virtual bool subst_argument_checker (uchar **arg)
 
virtual bool explain_subquery_checker (uchar **)
 
virtual Itemexplain_subquery_propagator (uchar *)
 
virtual Itemequal_fields_propagator (uchar *)
 
virtual bool disable_constant_propagation (uchar *)
 
virtual bool check_gcol_depend_default_processor (uchar *args)
 Check if a generated expression depends on DEFAULT function with specific column name as argument. More...
 
virtual Itemreplace_with_derived_expr (uchar *arg)
 Assuming this expression is part of a condition that would be pushed to the WHERE clause of a materialized derived table, replace, in this expression, each derived table's column with a clone of the expression lying under it in the derived table's definition. More...
 
virtual Itemreplace_with_derived_expr_ref (uchar *arg)
 Assuming this expression is part of a condition that would be pushed to the HAVING clause of a materialized derived table, replace, in this expression, each derived table's column with a reference to the expression lying under it in the derived table's definition. More...
 
virtual Itemreplace_view_refs_with_clone (uchar *arg)
 Assuming this expression is part of a condition that would be pushed to a materialized derived table, replace, in this expression, each view reference with a clone of the expression in merged derived table's definition. More...
 
virtual Itemthis_item ()
 
virtual const Itemthis_item () const
 
virtual Item ** this_item_addr (THD *, Item **addr_arg)
 
virtual uint cols () const
 
virtual Itemelement_index (uint)
 
virtual Item ** addr (uint)
 
virtual bool check_cols (uint c)
 
virtual bool null_inside ()
 
virtual void bring_value ()
 
Fieldtmp_table_field_from_field_type (TABLE *table, bool fixed_length) const
 Create a field based on field_type of argument. More...
 
virtual Item_fieldfield_for_view_update ()
 
virtual Itemtruth_transformer (THD *thd, Bool_test test)
 Informs an item that it is wrapped in a truth test, in case it wants to transforms itself to implement this test by itself. More...
 
virtual Itemupdate_value_transformer (uchar *)
 
virtual Itemreplace_scalar_subquery (uchar *)
 When walking the item tree seeing an Item_singlerow_subselect matching a target, replace it with a substitute field used when transforming scalar subqueries into derived tables. More...
 
virtual Itemreplace_item_field (uchar *)
 Transform processor used by Query_block::transform_grouped_to_derived to replace fields which used to be at the transformed query block with corresponding fields in the new derived table containing the grouping operation of the original transformed query block. More...
 
virtual Itemreplace_item_view_ref (uchar *)
 
virtual Itemreplace_aggregate (uchar *)
 
virtual Itemreplace_outer_ref (uchar *)
 
virtual bool update_aggr_refs (uchar *)
 A walker processor overridden by Item_aggregate_ref, q.v. More...
 
virtual Itemsafe_charset_converter (THD *thd, const CHARSET_INFO *tocs)
 
void delete_self ()
 Delete this item. More...
 
virtual bool is_splocal () const
 
virtual Settable_routine_parameterget_settable_routine_parameter ()
 
bool is_temporal_with_date () const
 
bool is_temporal_with_date_and_time () const
 
bool is_temporal_with_time () const
 
bool is_temporal () const
 
bool has_compatible_context (Item *item) const
 Check whether this and the given item has compatible comparison context. More...
 
virtual Field::geometry_type get_geometry_type () const
 
Stringcheck_well_formed_result (String *str, bool send_error, bool truncate)
 Verifies that the input string is well-formed according to its character set. More...
 
bool eq_by_collation (Item *item, bool binary_cmp, const CHARSET_INFO *cs)
 
CostOfItem cost () const
 
uint32 max_char_length () const
 
uint32 max_char_length (const CHARSET_INFO *cs) const
 
void fix_char_length (uint32 max_char_length_arg)
 
virtual bool is_outer_field () const
 
bool is_blob_field () const
 Check if an item either is a blob field, or will be represented as a BLOB field if a field is created based on this item. More...
 
uint reference_count () const
 
void increment_ref_count ()
 Increment reference count. More...
 
uint decrement_ref_count ()
 Decrement reference count. More...
 
bool has_subquery () const
 
bool has_stored_program () const
 
bool has_aggregation () const
 
void set_aggregation ()
 Set the "has aggregation" property. More...
 
void reset_aggregation ()
 Reset the "has aggregation" property. More...
 
bool has_wf () const
 
void set_wf ()
 Set the "has window function" property. More...
 
bool has_grouping_set_dep () const
 
void set_group_by_modifier ()
 Set the property: this item (tree) contains a reference to a GROUP BY modifier (such as ROLLUP) More...
 
bool has_grouping_func () const
 
void set_grouping_func ()
 Set the property: this item is a call to GROUPING. More...
 
virtual bool created_by_in2exists () const
 Whether this Item was created by the IN->EXISTS subquery transformation. More...
 
void mark_subqueries_optimized_away ()
 
virtual bool gc_subst_analyzer (uchar **)
 Analyzer function for GC substitution. More...
 
virtual bool replace_field_processor (uchar *)
 A processor that replaces any Fields with a Create_field_wrapper. More...
 
bool can_be_substituted_for_gc (bool array=false) const
 Check if this item is of a type that is eligible for GC substitution. More...
 
void aggregate_float_properties (enum_field_types type, Item **items, uint nitems)
 Set max_length and decimals of function if function is floating point and result length/precision depends on argument ones. More...
 
void aggregate_decimal_properties (Item **items, uint nitems)
 Set data type, precision and scale of item of type decimal from list of items. More...
 
uint32 aggregate_char_width (Item **items, uint nitems)
 Calculate the maximum number of characters required by any of the items. More...
 
void aggregate_temporal_properties (enum_field_types type, Item **items, uint nitems)
 Set data type and fractional seconds precision for temporal functions. More...
 
bool aggregate_string_properties (enum_field_types type, const char *name, Item **items, uint nitems)
 Aggregate string properties (character set, collation and maximum length) for string function. More...
 
void aggregate_bit_properties (Item **items, uint nitems)
 Set data type and properties of a BIT column. More...
 
virtual bool repoint_const_outer_ref (uchar *arg)
 This function applies only to Item_field objects referred to by an Item_ref object that has been marked as a const_item. More...
 
virtual bool strip_db_table_name_processor (uchar *)
 
virtual void compute_cost (CostOfItem *root_cost) const
 Compute the cost of evaluating this Item. More...
 
bool is_abandoned () const
 
bool is_nullable () const
 
void set_nullable (bool nullable)
 
virtual bool supports_partial_update (const Field_json *field) const
 Check if this expression can be used for partial update of a given JSON column. More...
 
virtual bool returns_array () const
 Whether the item returns array of its data type. More...
 
virtual void allow_array_cast ()
 A helper function to ensure proper usage of CAST(. More...
 
- Public Member Functions inherited from Parse_tree_node_tmpl< Context >
virtual ~Parse_tree_node_tmpl ()=default
 
bool is_contextualized () const
 
virtual bool contextualize (Context *pc) final
 
void error (Context *pc, const POS &pos) const
 syntax_error() function replacement for deferred reporting of syntax errors More...
 
void error (Context *pc, const POS &pos, const char *msg) const
 syntax_error() function replacement for deferred reporting of syntax errors More...
 
void errorf (Context *pc, const POS &pos, const char *format,...) const
 syntax_error() function replacement for deferred reporting of syntax errors More...
 

Static Public Member Functions

static bool check_argument_valid_integer (Item *argument)
 Checks if the supplied argument is a valid integer type. More...
 
- Static Public Member Functions inherited from Item
static void * operator new (size_t size) noexcept
 
static void * operator new (size_t size, MEM_ROOT *mem_root, const std::nothrow_t &arg=std::nothrow) noexcept
 
static void operator delete (void *ptr, size_t size)
 
static void operator delete (void *, MEM_ROOT *, const std::nothrow_t &) noexcept
 
static enum_field_types result_to_type (Item_result result)
 
static Item_result type_to_result (enum_field_types type)
 
static enum_field_types type_for_variable (enum_field_types src_type)
 Provide data type for a user or system variable, based on the type of the item that is assigned to the variable. More...
 
static enum_field_types string_field_type (uint32 max_bytes)
 Determine correct string field type, based on string length. More...
 
static const CHARSET_INFOdefault_charset ()
 
- Static Public Member Functions inherited from Parse_tree_node_tmpl< Context >
static void * operator new (size_t size, MEM_ROOT *mem_root, const std::nothrow_t &arg=std::nothrow) noexcept
 
static void operator delete (void *ptr, size_t size)
 
static void operator delete (void *, MEM_ROOT *, const std::nothrow_t &) noexcept
 

Static Public Attributes

static const char * TYPE_MEMBER = "type"
 Definition of various string constants used for writing and reading GeoJSON data. More...
 
static const char * CRS_MEMBER = "crs"
 
static const char * GEOMETRY_MEMBER = "geometry"
 
static const char * PROPERTIES_MEMBER = "properties"
 
static const char * FEATURES_MEMBER = "features"
 
static const char * GEOMETRIES_MEMBER = "geometries"
 
static const char * COORDINATES_MEMBER = "coordinates"
 
static const char * CRS_NAME_MEMBER = "name"
 
static const char * NAMED_CRS = "name"
 
static const char * SHORT_EPSG_PREFIX = "EPSG:"
 
static const char * LONG_EPSG_PREFIX
 
static const char * CRS84_URN
 
static const char * POINT_TYPE = "Point"
 
static const char * MULTIPOINT_TYPE = "MultiPoint"
 
static const char * LINESTRING_TYPE = "LineString"
 
static const char * MULTILINESTRING_TYPE = "MultiLineString"
 
static const char * POLYGON_TYPE = "Polygon"
 
static const char * MULTIPOLYGON_TYPE = "MultiPolygon"
 
static const char * GEOMETRYCOLLECTION_TYPE
 
static const char * FEATURE_TYPE = "Feature"
 
static const char * FEATURECOLLECTION_TYPE
 

Private Attributes

enum_handle_coordinate_dimension m_handle_coordinate_dimension
 How higher coordinate dimensions than currently supported should be handled. More...
 
bool m_user_provided_srid
 Is set to true if user provided a SRID as an argument. More...
 
gis::srid_t m_user_srid
 The SRID user provided as an argument. More...
 
longlong m_srid_found_in_document
 The SRID value of the document CRS, if one is found. More...
 
double m_min_longitude = -180.0
 The minimum allowed longitude value (non-inclusive). More...
 
double m_max_longitude = 180.0
 The maximum allowed longitude (inclusive). More...
 
double m_min_latitude = -90.0
 The minimum allowed latitude value (inclusive). More...
 
double m_max_latitude = 90.0
 The maximum allowed latitude (inclusive). More...
 
bool m_toplevel = true
 True if we're currently parsing the top-level object. More...
 

Additional Inherited Members

- Public Attributes inherited from Item_func
uint arg_count
 How many arguments in 'args'. More...
 
- Public Attributes inherited from Item
Itemnext_free
 Intrusive list pointer for free list. More...
 
DTCollation collation
 Character set and collation properties assigned for this Item. More...
 
Item_name_string item_name
 Name from query. More...
 
Item_name_string orig_name
 Original item name (if it was renamed) More...
 
uint32 max_length
 Maximum length of result of evaluating this item, in number of bytes. More...
 
item_marker marker
 This member has several successive meanings, depending on the phase we're in (. More...
 
Item_result cmp_context
 Comparison context. More...
 
bool fixed
 True if item has been resolved. More...
 
uint8 decimals
 Number of decimals in result when evaluating this item. More...
 
bool null_value
 True if item is null. More...
 
bool unsigned_flag
 
bool m_is_window_function
 True if item represents window func. More...
 
bool hidden {false}
 If the item is in a SELECT list (Query_block::fields) and hidden is true, the item wasn't actually in the list as given by the user (it was added by the optimizer, to e.g. More...
 
bool m_in_check_constraint_exec_ctx {false}
 True if item is a top most element in the expression being evaluated for a check constraint. More...
 
- Public Attributes inherited from Parse_tree_node_tmpl< Context >
POS m_pos
 
- Protected Member Functions inherited from Item_str_func
Stringpush_packet_overflow_warning (THD *thd, const char *func)
 Calls push_warning_printf for packet overflow. More...
 
void add_json_info (Json_object *obj) override
 Add all the node-specific json fields. More...
 
- Protected Member Functions inherited from Item_func
bool param_type_uses_non_param (THD *thd, enum_field_types def=MYSQL_TYPE_VARCHAR)
 
bool param_type_is_default (THD *thd, uint start, uint end, uint step, enum_field_types def)
 For arguments of this Item_func ("args" array), in range [start, start+step, start+2*step,...,end[ : if they're a PS parameter with invalid (not known) type, give them default type "def". More...
 
bool param_type_is_default (THD *thd, uint start, uint end, enum_field_types def=MYSQL_TYPE_VARCHAR)
 
bool param_type_is_rejected (uint start, uint end)
 For arguments of this Item_func ("args" array), in range [start,end[ : sends error if they're a dynamic parameter. More...
 
const Item_fieldcontributes_to_filter (THD *thd, table_map read_tables, table_map filter_for_table, const MY_BITMAP *fields_to_ignore) const
 Whether or not an item should contribute to the filtering effect (. More...
 
virtual bool may_have_named_parameters () const
 Named parameters are allowed in a parameter list. More...
 
bool is_non_const_over_literals (uchar *) override
 
bool check_function_as_value_generator (uchar *checker_args) override
 Check if this item is allowed for a virtual column or inside a default expression. More...
 
bool is_valid_for_pushdown (uchar *arg) override
 Check if all the columns present in this expression are from the derived table. More...
 
bool check_column_in_window_functions (uchar *arg) override
 Check if all the columns present in this expression are present in PARTITION clause of window functions of the derived table. More...
 
bool check_column_in_group_by (uchar *arg) override
 Check if all the columns present in this expression are present in GROUP BY clause of the derived table. More...
 
longlong val_int_from_real ()
 
- Protected Member Functions inherited from Item
Stringmake_empty_result ()
 Sets the result value of the function an empty string, using the current character set. More...
 
bool skip_itemize (Item **res)
 Helper function to skip itemize() for grammar-allocated items. More...
 
virtual type_conversion_status save_in_field_inner (Field *field, bool no_conversions)
 Helper function which does all of the work for save_in_field(Field*, bool), except some error checking common to all subclasses, which is performed by save_in_field() itself. More...
 
Stringval_string_from_real (String *str)
 
Stringval_string_from_int (String *str)
 
Stringval_string_from_decimal (String *str)
 
Stringval_string_from_date (String *str)
 
Stringval_string_from_datetime (String *str)
 
Stringval_string_from_time (String *str)
 
my_decimalval_decimal_from_real (my_decimal *decimal_value)
 
my_decimalval_decimal_from_int (my_decimal *decimal_value)
 
my_decimalval_decimal_from_string (my_decimal *decimal_value)
 
my_decimalval_decimal_from_date (my_decimal *decimal_value)
 
my_decimalval_decimal_from_time (my_decimal *decimal_value)
 
longlong val_int_from_decimal ()
 
longlong val_int_from_date ()
 
longlong val_int_from_time ()
 
longlong val_int_from_datetime ()
 
longlong val_int_from_string ()
 
double val_real_from_decimal ()
 
double val_real_from_string ()
 
bool error_bool ()
 Get the value to return from val_bool() in case of errors. More...
 
int error_int ()
 Get the value to return from val_int() in case of errors. More...
 
double error_real ()
 Get the value to return from val_real() in case of errors. More...
 
bool error_date ()
 Get the value to return from get_date() in case of errors. More...
 
bool error_time ()
 Get the value to return from get_time() in case of errors. More...
 
Stringnull_return_str ()
 Gets the value to return from val_str() when returning a NULL value. More...
 
bool get_date_from_string (MYSQL_TIME *ltime, my_time_flags_t flags)
 Convert val_str() to date in MYSQL_TIME. More...
 
bool get_date_from_real (MYSQL_TIME *ltime, my_time_flags_t flags)
 Convert val_real() to date in MYSQL_TIME. More...
 
bool get_date_from_decimal (MYSQL_TIME *ltime, my_time_flags_t flags)
 Convert val_decimal() to date in MYSQL_TIME. More...
 
bool get_date_from_int (MYSQL_TIME *ltime, my_time_flags_t flags)
 Convert val_int() to date in MYSQL_TIME. More...
 
bool get_date_from_time (MYSQL_TIME *ltime)
 Convert get_time() from time to date in MYSQL_TIME. More...
 
bool get_date_from_numeric (MYSQL_TIME *ltime, my_time_flags_t fuzzydate)
 Convert a numeric type to date. More...
 
bool get_time_from_string (MYSQL_TIME *ltime)
 Convert val_str() to time in MYSQL_TIME. More...
 
bool get_time_from_real (MYSQL_TIME *ltime)
 Convert val_real() to time in MYSQL_TIME. More...
 
bool get_time_from_decimal (MYSQL_TIME *ltime)
 Convert val_decimal() to time in MYSQL_TIME. More...
 
bool get_time_from_int (MYSQL_TIME *ltime)
 Convert val_int() to time in MYSQL_TIME. More...
 
bool get_time_from_date (MYSQL_TIME *ltime)
 Convert date to time. More...
 
bool get_time_from_datetime (MYSQL_TIME *ltime)
 Convert datetime to time. More...
 
bool get_time_from_numeric (MYSQL_TIME *ltime)
 Convert a numeric type to time. More...
 
virtual longlong val_date_temporal_at_utc ()
 
virtual longlong val_time_temporal_at_utc ()
 
void set_accum_properties (const Item *item)
 Set accumulated properties for an Item. More...
 
void add_accum_properties (const Item *item)
 Add more accumulated properties to an Item. More...
 
void set_subquery ()
 Set the "has subquery" property. More...
 
void set_stored_program ()
 Set the "has stored program" property. More...
 
- Protected Member Functions inherited from Parse_tree_node_tmpl< Context >
 Parse_tree_node_tmpl ()=delete
 
 Parse_tree_node_tmpl (const POS &pos)
 
 Parse_tree_node_tmpl (const POS &start_pos, const POS &end_pos)
 
bool begin_parse_tree (Show_parse_tree *tree)
 
bool end_parse_tree (Show_parse_tree *tree)
 
virtual bool do_contextualize (Context *pc)
 Do all context-sensitive things and mark the node as contextualized. More...
 
- Static Protected Member Functions inherited from Item
static bool bit_func_returns_binary (const Item *a, const Item *b)
 
static bool mark_field_in_map (Mark_field *mark_field, Field *field)
 Helper function for mark_field_in_map(uchar *arg). More...
 
- Protected Attributes inherited from Item_func
Item ** args
 Array of pointers to arguments. More...
 
bool null_on_null {true}
 Affects how to determine that NULL argument implies a NULL function return. More...
 
uint allowed_arg_cols {1}
 
table_map used_tables_cache {0}
 Value used in calculation of result of used_tables() More...
 
table_map not_null_tables_cache {0}
 Value used in calculation of result of not_null_tables() More...
 
- Protected Attributes inherited from Item_result_field
Fieldresult_field {nullptr}
 
- Protected Attributes inherited from Item
String str_value
 str_values's main purpose is to cache the value in save_in_field More...
 
uint8 m_accum_properties
 
- Static Protected Attributes inherited from Item
static constexpr uint8 PROP_SUBQUERY = 0x01
 Set of properties that are calculated by accumulation from underlying items. More...
 
static constexpr uint8 PROP_STORED_PROGRAM = 0x02
 
static constexpr uint8 PROP_AGGREGATION = 0x04
 
static constexpr uint8 PROP_WINDOW_FUNCTION = 0x08
 
static constexpr uint8 PROP_HAS_GROUPING_SET_DEP = 0x10
 Set if the item or one or more of the underlying items contains a GROUP BY modifier (such as ROLLUP). More...
 
static constexpr uint8 PROP_GROUPING_FUNC = 0x20
 Set if the item or one or more of the underlying items is a GROUPING function. More...
 

Detailed Description

This handles one function:

<geometry> = ST_GEOMFROMGEOJSON(<string>[, <options>[, <srid>]])

Options is an integer argument which determines how positions with higher coordinate dimension than MySQL support should be handled. The function will accept both single objects, geometry collections and feature objects and collections. All "properties" members of GeoJSON feature objects is ignored.

The implementation conforms with GeoJSON revision 1.0 described at http://geojson.org/geojson-spec.html.

Member Enumeration Documentation

◆ enum_handle_coordinate_dimension

Describing how coordinate dimensions higher than supported in MySQL should be handled.

Enumerator
reject_document 
strip_now_accept_future 
strip_now_reject_future 
strip_now_strip_future 

Constructor & Destructor Documentation

◆ Item_func_geomfromgeojson() [1/3]

Item_func_geomfromgeojson::Item_func_geomfromgeojson ( const POS pos,
Item json_string 
)
inline

◆ Item_func_geomfromgeojson() [2/3]

Item_func_geomfromgeojson::Item_func_geomfromgeojson ( const POS pos,
Item json_string,
Item options 
)
inline

◆ Item_func_geomfromgeojson() [3/3]

Item_func_geomfromgeojson::Item_func_geomfromgeojson ( const POS pos,
Item json_string,
Item options,
Item srid 
)
inline

Member Function Documentation

◆ check_argument_valid_integer()

bool Item_func_geomfromgeojson::check_argument_valid_integer ( Item argument)
static

Checks if the supplied argument is a valid integer type.

The function will fail if the supplied data is binary data. It will accept strings as integer type. Used for checking SRID and OPTIONS argument.

Parameters
argumentThe argument to check.
Returns
true if the argument is a valid integer type, false otherwise.

◆ fix_fields()

bool Item_func_geomfromgeojson::fix_fields ( THD thd,
Item **  ref 
)
overridevirtual

Do type checking on all provided arguments.

Reimplemented from Item_func.

◆ func_name()

const char * Item_func_geomfromgeojson::func_name ( ) const
inlineoverridevirtual

Implements Item_result_field.

◆ get_linestring()

bool Item_func_geomfromgeojson::get_linestring ( const Json_array data_array,
Gis_line_string linestring 
)

Create a Gis_line_string from a JSON array.

Parameters
data_arrayA JSON array containing the coordinates.
linestringPointer to a linestring to be filled with data.
Returns
true on failure, false otherwise.

◆ get_polygon()

bool Item_func_geomfromgeojson::get_polygon ( const Json_array data_array,
Gis_polygon polygon 
)

Create a Gis_polygon from a JSON array.

Parameters
data_arrayA JSON array containing the coordinates.
polygonA pointer to a Polygon to be filled with data.
Returns
true on failure, false otherwise.

◆ get_positions()

bool Item_func_geomfromgeojson::get_positions ( const Json_array coordinates,
Gis_point point 
)

Parse an array of coordinates to a Gis_point.

Parses an array of coordinates to a Gis_point. This function must handle according to the handle_dimension parameter on how non 2D objects should be handled.

According to the specification, a position array must have at least two elements, but there is no upper limit.

Parameters
coordinatesA JSON array of coordinates.
[out]pointA pointer to the parsed Gis_point.
Returns
true if the parsing failed, false otherwise.

◆ get_wkbtype()

Geometry::wkbType Item_func_geomfromgeojson::get_wkbtype ( const char *  typestring)

Converts GeoJSON type string to a wkbType.

Convert a string from a "type" member in GeoJSON to its equivalent Geometry enumeration. The type names are case sensitive as stated in the specification:

The value of the type member must be one of: "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", or "FeatureCollection". The case of the type member values must be as shown here.

Note that even though Feature and FeatureCollection are added here, these types will be handled before this function is called (in parse_object()).

Parameters
typestringA GeoJSON type string.
Returns
The corresponding wkbType, or wkb_invalid_type if no matching type was found.

◆ is_member_valid()

bool Item_func_geomfromgeojson::is_member_valid ( const Json_dom member,
const char *  member_name,
enum_json_type  expected_type,
bool  allow_null,
bool *  was_null 
)

Checks if a JSON member is valid based on input criteria.

This function checks if the provided member exists, and if it's of the expected type. If it fails ome of the test, my_error() is called and false is returned from the function.

Parameters
memberThe member to validate.
member_nameName of the member we are validating, so that the error returned to the user is more informative.
expected_typeExpected type of the member.
allow_nullIf we should allow the member to have JSON null value.
[out]was_nullThis will be set to true if the provided member had a JSON null value. Is only affected if allow_null is set to true.
Returns
true if the member is valid, false otherwise.

◆ my_find_member_ncase()

const Json_dom * Item_func_geomfromgeojson::my_find_member_ncase ( const Json_object object,
const char *  member_name 
)

Case insensitive lookup of a member in a JSON object.

This is needed since the get()-method of the JSON object is case sensitive.

Parameters
objectThe object to look for the member in.
member_nameName of the member to look after
Returns
The member if one was found, nullptr otherwise.

◆ parse_crs_object()

bool Item_func_geomfromgeojson::parse_crs_object ( const Json_object crs_object)

Takes a GeoJSON CRS object as input and parses it into a SRID.

If user has supplied a SRID, the parsing will be ignored.

GeoJSON support two types of CRS objects; named and linked. Linked CRS will force us to download CRS parameters from the web, which we do not allow. Thus, we will only parse named CRS URNs in the "urn:ogc:def:crs:EPSG::<srid>" and "EPSG:<srid>" namespaces. In addition, "urn:ogc:def:crs:OGC:1.3:CRS84" will be recognized as SRID 4326. Note that CRS object with value JSON null is valid.

Parameters
crs_objectA GeoJSON CRS object to parse.
Returns
false if the parsing was successful, or true if it didn't understand the CRS object provided.

◆ parse_object()

bool Item_func_geomfromgeojson::parse_object ( const Json_object object,
bool *  rollback,
String buffer,
bool  is_parent_featurecollection,
Geometry **  geometry 
)

Takes a JSON object as input, and parses the data to a Geometry object.

The call stack will be no larger than the maximum depth of the GeoJSON document, which is more or less equivalent to the number of nested collections in the document.

Parameters
objectA JSON object object to parse.
rollbackPointer to a boolean indicating if parsed data should be reverted/rolled back.
bufferA string buffer to be used by GeometryCollection
is_parent_featurecollectionIndicating if the current geometry is a child of a FeatureCollection.
[out]geometryA pointer to the parsed geometry.
Returns
true if the parsing failed, false otherwise. Note that if rollback is set to true and true is returned, the parsing succeeded, but no Geometry data could be parsed.

◆ parse_object_array()

bool Item_func_geomfromgeojson::parse_object_array ( const Json_array data_array,
Geometry::wkbType  type,
bool *  rollback,
String buffer,
bool  is_parent_featurecollection,
Geometry **  geometry 
)

Takes a JSON array as input, does a recursive parsing and returns a Geometry object.

This function differs from parse_object() in that it takes an array as input instead of a object. This is one of the members "coordinates" or "geometries" of a GeoJSON object.

Parameters
data_arrayA JSON array to parse.
typeThe type of the GeoJSON object this array belongs to.
rollbackPointer to a boolean indicating if parsed data should be reverted/rolled back.
bufferA String buffer to be used by GeometryCollection.
is_parent_featurecollectionIndicating if the current geometry is a child of a FeatureCollection.
[out]geometryA pointer to the parsed Geometry.
Returns
true on failure, false otherwise.

◆ val_str()

String * Item_func_geomfromgeojson::val_str ( String buf)
overridevirtual

<geometry> = ST_GEOMFROMGEOJSON(<string>[, <options>[, <srid>]])

Takes a GeoJSON input string and outputs a GEOMETRY. This function supports both single GeoJSON objects and geometry collections.

In addition, feature objects and feature collections are supported (feature collections are translated into GEOMETRYCOLLECTION).

It follows the standard described at http://geojson.org/geojson-spec.html (revision 1.0).

Implements Item.

Member Data Documentation

◆ COORDINATES_MEMBER

const char * Item_func_geomfromgeojson::COORDINATES_MEMBER = "coordinates"
static

◆ CRS84_URN

const char * Item_func_geomfromgeojson::CRS84_URN
static
Initial value:
=
"urn:ogc:def:crs:OGC:1.3:CRS84"

◆ CRS_MEMBER

const char * Item_func_geomfromgeojson::CRS_MEMBER = "crs"
static

◆ CRS_NAME_MEMBER

const char * Item_func_geomfromgeojson::CRS_NAME_MEMBER = "name"
static

◆ FEATURE_TYPE

const char * Item_func_geomfromgeojson::FEATURE_TYPE = "Feature"
static

◆ FEATURECOLLECTION_TYPE

const char * Item_func_geomfromgeojson::FEATURECOLLECTION_TYPE
static
Initial value:
=
"FeatureCollection"

◆ FEATURES_MEMBER

const char * Item_func_geomfromgeojson::FEATURES_MEMBER = "features"
static

◆ GEOMETRIES_MEMBER

const char * Item_func_geomfromgeojson::GEOMETRIES_MEMBER = "geometries"
static

◆ GEOMETRY_MEMBER

const char * Item_func_geomfromgeojson::GEOMETRY_MEMBER = "geometry"
static

◆ GEOMETRYCOLLECTION_TYPE

const char * Item_func_geomfromgeojson::GEOMETRYCOLLECTION_TYPE
static
Initial value:
=
"GeometryCollection"

◆ LINESTRING_TYPE

const char * Item_func_geomfromgeojson::LINESTRING_TYPE = "LineString"
static

◆ LONG_EPSG_PREFIX

const char * Item_func_geomfromgeojson::LONG_EPSG_PREFIX
static
Initial value:
=
"urn:ogc:def:crs:EPSG::"

◆ m_handle_coordinate_dimension

enum_handle_coordinate_dimension Item_func_geomfromgeojson::m_handle_coordinate_dimension
private

How higher coordinate dimensions than currently supported should be handled.

◆ m_max_latitude

double Item_func_geomfromgeojson::m_max_latitude = 90.0
private

The maximum allowed latitude (inclusive).

◆ m_max_longitude

double Item_func_geomfromgeojson::m_max_longitude = 180.0
private

The maximum allowed longitude (inclusive).

◆ m_min_latitude

double Item_func_geomfromgeojson::m_min_latitude = -90.0
private

The minimum allowed latitude value (inclusive).

◆ m_min_longitude

double Item_func_geomfromgeojson::m_min_longitude = -180.0
private

The minimum allowed longitude value (non-inclusive).

◆ m_srid_found_in_document

longlong Item_func_geomfromgeojson::m_srid_found_in_document
private

The SRID value of the document CRS, if one is found.

Otherwise, this value defaults to -1.

◆ m_toplevel

bool Item_func_geomfromgeojson::m_toplevel = true
private

True if we're currently parsing the top-level object.

◆ m_user_provided_srid

bool Item_func_geomfromgeojson::m_user_provided_srid
private

Is set to true if user provided a SRID as an argument.

◆ m_user_srid

gis::srid_t Item_func_geomfromgeojson::m_user_srid
private

The SRID user provided as an argument.

◆ MULTILINESTRING_TYPE

const char * Item_func_geomfromgeojson::MULTILINESTRING_TYPE = "MultiLineString"
static

◆ MULTIPOINT_TYPE

const char * Item_func_geomfromgeojson::MULTIPOINT_TYPE = "MultiPoint"
static

◆ MULTIPOLYGON_TYPE

const char * Item_func_geomfromgeojson::MULTIPOLYGON_TYPE = "MultiPolygon"
static

◆ NAMED_CRS

const char * Item_func_geomfromgeojson::NAMED_CRS = "name"
static

◆ POINT_TYPE

const char * Item_func_geomfromgeojson::POINT_TYPE = "Point"
static

◆ POLYGON_TYPE

const char * Item_func_geomfromgeojson::POLYGON_TYPE = "Polygon"
static

◆ PROPERTIES_MEMBER

const char * Item_func_geomfromgeojson::PROPERTIES_MEMBER = "properties"
static

◆ SHORT_EPSG_PREFIX

const char * Item_func_geomfromgeojson::SHORT_EPSG_PREFIX = "EPSG:"
static

◆ TYPE_MEMBER

const char * Item_func_geomfromgeojson::TYPE_MEMBER = "type"
static

Definition of various string constants used for writing and reading GeoJSON data.


The documentation for this class was generated from the following files: