create_index¶

In [ ]:

create_index(vdf: vDataFrame,
             gid: str,
             g: str,
             index: str,
             overwrite: bool = False,
             max_mem_mb: int = 256,
             skip_nonindexable_polygons: bool = False)

Creates a spatial index on a set of polygons to speed up spatial intersection with a set of points.

Parameters¶

Name	Type	Optional	Description
vdf	vDataFrame	❌	vDataFrame to use to compute the spatial join.
gid	str	❌	Name of an integer column that uniquely identifies the polygon. The gid cannot be NULL.
g	str	❌	Name of a geometry or geography (WGS84) column or expression that contains polygons and multipolygons. Only polygon and multipolygon can be indexed. Other shape types are excluded from the index.
index	str	✓	Name of the index.
overwrite	bool	✓	BOOLEAN value that specifies whether to overwrite the index, if an index exists.
max_mem_mb	int	✓	A positive integer that assigns a limit to the amount of memory in megabytes that create_index can allocate during index construction.
skip_nonindexable_polygons	bool	✓	In rare cases, intricate polygons (for instance, with too high resolution or anomalous spikes) cannot be indexed. These polygons are considered non-indexable. When set to False, non-indexable polygons cause the index creation to fail. When set to True, index creation can succeed by excluding non-indexable polygons from the index.

Returns¶

tablesample : An object containing the result. For more information, see utilities.tablesample.

Example¶

In [3]:

from verticapy.geo import *
from verticapy.learn.datasets import load_world

world = load_world()
world["id"] = "ROW_NUMBER() OVER(ORDER BY country, pop_est)"
display(world)

	123 pop_est Int	Abc continent Varchar(32)	Abc country Varchar(82)	🌎 Geometry(1048576)	123 id Integer
1	34124811	Asia	Afghanistan		1
2	3047987	Europe	Albania		2
3	40969443	Africa	Algeria		3
4	29310273	Africa	Angola		4
5	4050	Antarctica	Antarctica		5
6	44293293	South America	Argentina		6
7	3045191	Asia	Armenia		7
8	23232413	Oceania	Australia		8
9	8754413	Europe	Austria		9
10	9961396	Asia	Azerbaijan		10
11	329988	North America	Bahamas		11
12	157826578	Asia	Bangladesh		12
13	9549747	Europe	Belarus		13
14	11491346	Europe	Belgium		14
15	360346	North America	Belize		15
16	11038805	Africa	Benin		16
17	758288	Asia	Bhutan		17
18	11138234	South America	Bolivia		18
19	3856181	Europe	Bosnia and Herz.		19
20	2214858	Africa	Botswana		20
21	207353391	South America	Brazil		21
22	443593	Asia	Brunei		22
23	7101510	Europe	Bulgaria		23
24	20107509	Africa	Burkina Faso		24
25	11466756	Africa	Burundi		25
26	16204486	Asia	Cambodia		26
27	24994885	Africa	Cameroon		27
28	35623680	North America	Canada		28
29	5625118	Africa	Central African Rep.		29
30	12075985	Africa	Chad		30
31	17789267	South America	Chile		31
32	1379302771	Asia	China		32
33	47698524	South America	Colombia		33
34	4954674	Africa	Congo		34
35	4930258	North America	Costa Rica		35
36	4292095	Europe	Croatia		36
37	11147407	North America	Cuba		37
38	1221549	Asia	Cyprus		38
39	10674723	Europe	Czechia		39
40	24184810	Africa	Côte d'Ivoire		40
41	83301151	Africa	Dem. Rep. Congo		41
42	5605948	Europe	Denmark		42
43	865267	Africa	Djibouti		43
44	10734247	North America	Dominican Rep.		44
45	16290913	South America	Ecuador		45
46	97041072	Africa	Egypt		46
47	6172011	North America	El Salvador		47
48	778358	Africa	Eq. Guinea		48
49	5918919	Africa	Eritrea		49
50	1251581	Europe	Estonia		50
51	105350020	Africa	Ethiopia		51
52	2931	South America	Falkland Is.		52
53	920938	Oceania	Fiji		53
54	5491218	Europe	Finland		54
55	140	Seven seas (open ocean)	Fr. S. Antarctic Lands		55
56	67106161	Europe	France		56
57	1772255	Africa	Gabon		57
58	2051363	Africa	Gambia		58
59	4926330	Asia	Georgia		59
60	80594017	Europe	Germany		60
61	27499924	Africa	Ghana		61
62	10768477	Europe	Greece		62
63	57713	North America	Greenland		63
64	15460732	North America	Guatemala		64
65	12413867	Africa	Guinea		65
66	1792338	Africa	Guinea-Bissau		66
67	737718	South America	Guyana		67
68	10646714	North America	Haiti		68
69	9038741	North America	Honduras		69
70	9850845	Europe	Hungary		70
71	339747	Europe	Iceland		71
72	1281935911	Asia	India		72
73	260580739	Asia	Indonesia		73
74	82021564	Asia	Iran		74
75	39192111	Asia	Iraq		75
76	5011102	Europe	Ireland		76
77	8299706	Asia	Israel		77
78	62137802	Europe	Italy		78
79	2990561	North America	Jamaica		79
80	126451398	Asia	Japan		80
81	10248069	Asia	Jordan		81
82	18556698	Asia	Kazakhstan		82
83	47615739	Africa	Kenya		83
84	1895250	Europe	Kosovo		84
85	2875422	Asia	Kuwait		85
86	5789122	Asia	Kyrgyzstan		86
87	7126706	Asia	Laos		87
88	1944643	Europe	Latvia		88
89	6229794	Asia	Lebanon		89
90	1958042	Africa	Lesotho		90
91	4689021	Africa	Liberia		91
92	6653210	Africa	Libya		92
93	2823859	Europe	Lithuania		93
94	594130	Europe	Luxembourg		94
95	2103721	Europe	Macedonia		95
96	25054161	Africa	Madagascar		96
97	19196246	Africa	Malawi		97
98	31381992	Asia	Malaysia		98
99	17885245	Africa	Mali		99
100	3758571	Africa	Mauritania		100

Rows: 1-100 | Columns: 5

In [4]:

create_index(world, "id", "geometry", "world_polygons", True)

Out[4]:

	Abc type Varchar(20)	123 polygons Integer	123 SRID Integer	123 min_x Float	123 min_y Float	123 max_x Float	123 max_y Float	Abc info Varchar(500)
1	GEOMETRY	177	0	-180.0	-90.0	180.0	83.64513

Rows: 1-1 | Columns: 8