index: add virtual methods for creating arrow streams

Currently, these methods are implemented only by memcs (available in EE
only) so we don't really need to make them virtual. In future, however,
we're planning to introduce a new column store engine, which will export
the arrow API, too.

NO_DOC=internal
NO_TEST=internal
NO_CHANGELOG=internal

Author: locker

src/box/index.cc

@@ -1158,7 +1158,7 @@ generic_index_create_iterator(struct index *base, enum iterator_type type,
 	(void)key;
 	(void)part_count;
 	(void)pos;
-	diag_set(UnsupportedIndexFeature, base->def, "read view");
+	diag_set(UnsupportedIndexFeature, base->def, "iterator");
 	return NULL;
 }
 
@@ -1218,6 +1218,41 @@ generic_index_read_view_create_iterator_with_offset(
 	return -1;
 }
 
+int
+generic_index_create_arrow_stream(struct index *index,
+				  uint32_t field_count, const uint32_t *fields,
+				  const char *key, uint32_t part_count,
+				  const struct arrow_options *options,
+				  struct ArrowArrayStream *stream)
+{
+	(void)field_count;
+	(void)fields;
+	(void)key;
+	(void)part_count;
+	(void)options;
+	(void)stream;
+	diag_set(UnsupportedIndexFeature, index->def, "arrow stream");
+	return -1;
+}
+
+int
+generic_index_read_view_create_arrow_stream(
+	struct index_read_view *rv,
+	uint32_t field_count, const uint32_t *fields,
+	const char *key, uint32_t part_count,
+	const struct arrow_options *options,
+	struct ArrowArrayStream *stream)
+{
+	(void)field_count;
+	(void)fields;
+	(void)key;
+	(void)part_count;
+	(void)options;
+	(void)stream;
+	diag_set(UnsupportedIndexFeature, rv->def, "arrow stream in read view");
+	return -1;
+}
+
 struct index_read_view *
 generic_index_create_read_view(struct index *index)
 {

src/box/index.h

@@ -52,6 +52,8 @@ struct index_read_view_iterator;
 struct index_def;
 struct key_def;
 struct info_handler;
+struct arrow_options;
+struct ArrowArrayStream;
 
 typedef struct tuple box_tuple_t;
 typedef struct key_def box_key_def_t;
@@ -657,6 +659,12 @@ struct index_vtab {
 							uint32_t part_count,
 							const char *pos,
 							uint32_t offset);
+	/** Create an index Arrow stream. */
+	int (*create_arrow_stream)(struct index *index,
+				   uint32_t field_count, const uint32_t *fields,
+				   const char *key, uint32_t part_count,
+				   const struct arrow_options *options,
+				   struct ArrowArrayStream *stream);
 	/** Create an index read view. */
 	struct index_read_view *(*create_read_view)(struct index *index);
 	/** Introspection (index:stat()) */
@@ -777,6 +785,13 @@ struct index_read_view_vtab {
 				       const char *key, uint32_t part_count,
 				       const char *pos, uint32_t offset,
 				       struct index_read_view_iterator *it);
+	/** Create an index read view Arrow stream. */
+	int
+	(*create_arrow_stream)(struct index_read_view *rv,
+			       uint32_t field_count, const uint32_t *fields,
+			       const char *key, uint32_t part_count,
+			       const struct arrow_options *options,
+			       struct ArrowArrayStream *stream);
 };
 
 /**
@@ -1046,6 +1061,18 @@ index_create_iterator(struct index *index, enum iterator_type type,
 	return index->vtab->create_iterator(index, type, key, part_count, NULL);
 }
 
+static inline int
+index_create_arrow_stream(struct index *index,
+			  uint32_t field_count, const uint32_t *fields,
+			  const char *key, uint32_t part_count,
+			  const struct arrow_options *options,
+			  struct ArrowArrayStream *stream)
+{
+	return index->vtab->create_arrow_stream(index, field_count, fields,
+						key, part_count, options,
+						stream);
+}
+
 static inline struct index_read_view *
 index_create_read_view(struct index *index)
 {
@@ -1174,6 +1201,19 @@ index_read_view_iterator_position(struct index_read_view_iterator *iterator,
 	return iterator->base.position(iterator, pos, size);
 }
 
+static inline int
+index_read_view_create_arrow_stream(
+	struct index_read_view *rv,
+	uint32_t field_count, const uint32_t *fields,
+	const char *key, uint32_t part_count,
+	const struct arrow_options *options,
+	struct ArrowArrayStream *stream)
+{
+	return rv->vtab->create_arrow_stream(rv, field_count, fields,
+					     key, part_count, options,
+					     stream);
+}
+
 /*
  * Virtual method stubs.
  */
@@ -1227,6 +1267,19 @@ generic_index_read_view_create_iterator_with_offset(
 	const char *key, uint32_t part_count,
 	const char *pos, uint32_t offset,
 	struct index_read_view_iterator *it);
+int
+generic_index_create_arrow_stream(struct index *index,
+				  uint32_t field_count, const uint32_t *fields,
+				  const char *key, uint32_t part_count,
+				  const struct arrow_options *options,
+				  struct ArrowArrayStream *stream);
+int
+generic_index_read_view_create_arrow_stream(
+	struct index_read_view *rv,
+	uint32_t field_count, const uint32_t *fields,
+	const char *key, uint32_t part_count,
+	const struct arrow_options *options,
+	struct ArrowArrayStream *stream);
 int generic_index_build_next(struct index *, struct tuple *);
 void generic_index_end_build(struct index *);
 int

src/box/memtx_bitset.cc

@@ -525,6 +525,7 @@ static const struct index_vtab memtx_bitset_index_vtab = {
 	/* .create_iterator = */ memtx_bitset_index_create_iterator,
 	/* .create_iterator_with_offset = */
 	generic_index_create_iterator_with_offset,
+	/* .create_arrow_stream = */ generic_index_create_arrow_stream,
 	/* .create_read_view = */ generic_index_create_read_view,
 	/* .stat = */ generic_index_stat,
 	/* .compact = */ generic_index_compact,

src/box/memtx_hash.cc

@@ -632,6 +632,8 @@ memtx_hash_index_create_read_view(struct index *base)
 		.create_iterator = hash_read_view_create_iterator,
 		.create_iterator_with_offset =
 			generic_index_read_view_create_iterator_with_offset,
+		.create_arrow_stream =
+			generic_index_read_view_create_arrow_stream,
 	};
 	struct memtx_hash_index *index = (struct memtx_hash_index *)base;
 	struct hash_read_view *rv =
@@ -670,6 +672,7 @@ static const struct index_vtab memtx_hash_index_vtab = {
 	/* .create_iterator = */ memtx_hash_index_create_iterator,
 	/* .create_iterator_with_offset = */
 	generic_index_create_iterator_with_offset,
+	/* .create_arrow_stream = */ generic_index_create_arrow_stream,
 	/* .create_read_view = */ memtx_hash_index_create_read_view,
 	/* .stat = */ generic_index_stat,
 	/* .compact = */ generic_index_compact,

src/box/memtx_rtree.cc

@@ -423,6 +423,7 @@ static const struct index_vtab memtx_rtree_index_vtab = {
 	/* .create_iterator = */ memtx_rtree_index_create_iterator,
 	/* .create_iterator_with_offset = */
 	generic_index_create_iterator_with_offset,
+	/* .create_arrow_stream = */ generic_index_create_arrow_stream,
 	/* .create_read_view = */ generic_index_create_read_view,
 	/* .stat = */ generic_index_stat,
 	/* .compact = */ generic_index_compact,

src/box/memtx_tree.cc

@@ -2455,6 +2455,8 @@ memtx_tree_index_create_read_view(struct index *base)
 		.create_iterator = tree_read_view_create_iterator<USE_HINT>,
 		.create_iterator_with_offset =
 			tree_read_view_create_iterator_with_offset<USE_HINT>,
+		.create_arrow_stream =
+			generic_index_read_view_create_arrow_stream,
 	};
 	struct memtx_tree_index<USE_HINT> *index =
 		(struct memtx_tree_index<USE_HINT> *)base;
@@ -2500,6 +2502,7 @@ static const struct index_vtab memtx_tree_disabled_index_vtab = {
 	/* .create_iterator = */ generic_index_create_iterator,
 	/* .create_iterator_with_offset = */
 	generic_index_create_iterator_with_offset,
+	/* .create_arrow_stream = */ generic_index_create_arrow_stream,
 	/* .create_read_view = */ generic_index_create_read_view,
 	/* .stat = */ generic_index_stat,
 	/* .compact = */ generic_index_compact,
@@ -2566,6 +2569,7 @@ get_memtx_tree_index_vtab(void)
 			memtx_tree_index_create_iterator<USE_HINT>,
 		/* .create_iterator_with_offset = */
 		memtx_tree_index_create_iterator_with_offset<USE_HINT>,
+		/* .create_arrow_stream = */ generic_index_create_arrow_stream,
 		/* .create_read_view = */
 			memtx_tree_index_create_read_view<USE_HINT>,
 		/* .stat = */ generic_index_stat,

src/box/sequence.c

@@ -419,6 +419,8 @@ sequence_data_read_view_create(struct index *index)
 		.create_iterator = sequence_data_iterator_create,
 		.create_iterator_with_offset =
 			generic_index_read_view_create_iterator_with_offset,
+		.create_arrow_stream =
+			generic_index_read_view_create_arrow_stream,
 	};
 	struct sequence_data_read_view *rv = xmalloc(sizeof(*rv));
 	index_read_view_create(&rv->base, &vtab, index->def);

src/box/session_settings.c

@@ -285,6 +285,7 @@ static const struct index_vtab session_settings_index_vtab = {
 	/* .create_iterator = */ session_settings_index_create_iterator,
 	/* .create_iterator_with_offset = */
 	generic_index_create_iterator_with_offset,
+	/* .create_arrow_stream = */ generic_index_create_arrow_stream,
 	/* .create_read_view = */ generic_index_create_read_view,
 	/* .stat = */ generic_index_stat,
 	/* .compact = */ generic_index_compact,

src/box/sysview.c

@@ -196,6 +196,7 @@ static const struct index_vtab sysview_index_vtab = {
 	/* .create_iterator = */ sysview_index_create_iterator,
 	/* .create_iterator_with_offset = */
 	generic_index_create_iterator_with_offset,
+	/* .create_arrow_stream = */ generic_index_create_arrow_stream,
 	/* .create_read_view = */ generic_index_create_read_view,
 	/* .stat = */ generic_index_stat,
 	/* .compact = */ generic_index_compact,

src/box/vinyl.c

@@ -4840,6 +4840,7 @@ static const struct index_vtab vinyl_index_vtab = {
 	/* .create_iterator = */ vinyl_index_create_iterator,
 	/* .create_iterator_with_offset = */
 	generic_index_create_iterator_with_offset,
+	/* .create_arrow_stream = */ generic_index_create_arrow_stream,
 	/* .create_read_view = */ generic_index_create_read_view,
 	/* .stat = */ vinyl_index_stat,
 	/* .compact = */ vinyl_index_compact,