describe_index

In [ ]:
describe_index(name: str = "", 
               cursor=None, 
               list_polygons: bool = False,)

Retrieves information on an index that contains a set of polygons. If you do not pass any parameters, the function returns all defined indexes.

Parameters

Name Type Optional Description
name
str
Index name.
cursor
DBcursor
Vertica DB cursor.
list_polygons
bool
Boolean that specifies whether to list the polygons in the index. If set to True, the function will return a vDataFrame instead of a tablesample.

Returns

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

Example

In [30]:
from verticapy.geo import *

# Describes all indexes
describe_index()
Out[30]:
Abc
name
Varchar(4096)
1world_polygon
2world_counties
Rows: 1-2 | Column: name | Type: Varchar(4096)
In [31]:
# Describing a specific index
describe_index("world_polygon")
Out[31]:
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
1GEOMETRY1770-180.0-90.0180.083.64513
Rows: 1-1 | Columns: 7
In [32]:
# Describing all the geometries of a specific index
describe_index("world_polygon",
               list_polygons = True)
Out[32]:
123
gid
Int
Abc
state
Varchar(20)
🌎
Geometry(13167)
1140INDEXED
22931INDEXED
34050INDEXED
457713INDEXED
5265100INDEXED
6279070INDEXED
7282814INDEXED
8329988INDEXED
9339747INDEXED
10360346INDEXED
11443593INDEXED
12591919INDEXED
13594130INDEXED
14603253INDEXED
15642550INDEXED
16647581INDEXED
17737718INDEXED
18758288INDEXED
19778358INDEXED
20865267INDEXED
21920938INDEXED
221218208INDEXED
231221549INDEXED
241251581INDEXED
251291358INDEXED
261467152INDEXED
271772255INDEXED
281792338INDEXED
291895250INDEXED
301944643INDEXED
311958042INDEXED
321972126INDEXED
332051363INDEXED
342103721INDEXED
352214858INDEXED
362314307INDEXED
372484780INDEXED
382823859INDEXED
392875422INDEXED
402990561INDEXED
413045191INDEXED
423047987INDEXED
433068243INDEXED
443351827INDEXED
453360148INDEXED
463424386INDEXED
473474121INDEXED
483500000INDEXED
493753142INDEXED
503758571INDEXED
513856181INDEXED
524292095INDEXED
534510327INDEXED
544543126INDEXED
554689021INDEXED
564926330INDEXED
574930258INDEXED
584954674INDEXED
595011102INDEXED
605320045INDEXED
615351277INDEXED
625445829INDEXED
635491218INDEXED
645605948INDEXED
655625118INDEXED
665789122INDEXED
675918919INDEXED
686025951INDEXED
696072475INDEXED
706163195INDEXED
716172011INDEXED
726229794INDEXED
736653210INDEXED
746909701INDEXED
756943739INDEXED
767101510INDEXED
777111024INDEXED
787126706INDEXED
797531386INDEXED
807965055INDEXED
818236303INDEXED
828299706INDEXED
838468555INDEXED
848754413INDEXED
859038741INDEXED
869549747INDEXED
879850845INDEXED
889960487INDEXED
899961396INDEXED
9010248069INDEXED
9110646714INDEXED
9210674723INDEXED
9310734247INDEXED
9410768477INDEXED
9510839514INDEXED
9611038805INDEXED
9711138234INDEXED
9811147407INDEXED
9911403800INDEXED
10011466756INDEXED
Rows: 1-100 | Columns: 3