Loading...

verticapy.read_pandas

verticapy.read_pandas(df: DataFrame, name: str | None = None, schema: str | None = None, dtype: dict | None = None, parse_nrows: int = 10000, temp_path: str | None = None, insert: bool = False, abort_on_error: bool = False) → vDataFrame

Ingests a pandas.DataFrame into the Vertica database by creating a CSV file and then using flex tables to load the data.

Parameters

df: pandas.DataFrame

The pandas.DataFrame to ingest.

name: str, optional

Name of the new relation or the relation in which to insert the data. If unspecified, a temporary local table is created. This temporary table is dropped at the end of the local session.

schema: str, optional

Schema of the new relation. If empty, a temporary schema is used. To modify the temporary schema, use the set_option() function.

dtype: dict, optional

Dictionary of input types. Providing a dictionary can increase ingestion speed and precision. If specified, rather than parsing the intermediate CSV and guessing the input types, VerticaPy uses the specified input types instead.

parse_nrows: int, optional

If this parameter is greater than zero, VerticaPy creates and ingests a temporary file containing parse_nrows number of rows to determine the input data types before ingesting the intermediate CSV file containing the rest of the data. This method of data type identification is less accurate, but is much faster for large datasets.

temp_path: str, optional

The path to which to write the intermediate CSV file. This is useful in cases where the user does not have write permissions on the current directory.

insert: bool, optional

If set to True, the data are ingested into the input relation. The column names of your table and the pandas.DataFrame must match.

abort_on_error: bool, optional

If set to True, any parser error that would reject a row will cause the copy statement to fail and rollback.

Returns

vDataFrame

vDataFrame of the new relation.

Examples

In this example, we will first create a pandas.DataFrame using vDataFrame.to_pandas() and ingest it into Vertica database.

We import verticapy:

import verticapy as vp

Hint

By assigning an alias to verticapy, we mitigate the risk of code collisions with other libraries. This precaution is necessary because verticapy uses commonly known function names like “average” and “median”, which can potentially lead to naming conflicts. The use of an alias ensures that the functions from verticapy are used as intended without interfering with functions from other libraries.

We will use the Titanic dataset.

import verticapy.datasets as vpd

data = vpd.load_titanic()
123
pclass
Integer
123
survived
Integer
Abc
Varchar(164)
Abc
sex
Varchar(20)
123
age
Numeric(8)
123
sibsp
Integer
123
parch
Integer
Abc
ticket
Varchar(36)
123
fare
Numeric(12)
Abc
cabin
Varchar(30)
Abc
embarked
Varchar(20)
Abc
boat
Varchar(100)
123
body
Integer
Abc
Varchar(100)
110male71.000PC 1760949.5042[null]C[null]22
210male45.00011378435.5TS[null][null]
310male[null]0011379831.0[null]S[null][null]
410male17.00011305947.1[null]S[null][null]
510male27.01013508136.7792C89C[null][null]
610male37.011PC 1775683.1583E52C[null][null]
710male31.010F.C. 1275052.0B71S[null][null]
810male50.010PC 17761106.425C86C[null]62
910female36.000PC 1753131.6792A29C[null][null]
1010male37.01011380353.1C123S[null][null]
1110male24.000PC 1759379.2B86C[null][null]
1210male45.0103697383.475C83S[null][null]
1310male40.0001120590.0B94S[null]110
1410male42.00011303842.5B11S[null][null]
1510male[null]001746351.8625E46S[null][null]
1610male42.01011378952.0[null]S[null]38
1710male[null]00PC 1760030.6958[null]C14[null]
1810male29.00011350130.0D6S[null]126
1910male46.0001305075.2417C6C[null]292
2010male54.0001746351.8625E46S[null]175
2110male47.00011379642.4[null]S[null][null]
2210male58.00235273113.275D48C[null]122
2310male45.50011304328.5C124S[null]166
2410male29.01011377666.6C2S[null][null]
2510male47.00011046552.0C110S[null]207
2610male38.000199720.0[null]S[null][null]
2710male22.000PC 17760135.6333[null]C[null]232
2810male31.000PC 1759050.4958A24S[null][null]
2910male50.0101350755.9E44S[null][null]
3010male56.0001776430.6958A7C[null][null]
3110male57.010PC 17569146.5208B78C[null][null]
3210female63.010PC 17483221.7792C55 C57S[null][null]
3310male61.0003696332.3208D50S[null]46
3410male21.0013528177.2875D26S[null]169
3510male51.001PC 1759761.3792[null]C[null][null]
3611female63.0101350277.9583D7S10[null]
3711female32.0001181376.2917D15C8[null]
3811female58.00011378326.55C103S8[null]
3911female44.000PC 1761027.7208B4C6[null]
4011female41.00016966134.5E40C3[null]
4111female53.000PC 1760627.4458[null]C6[null]
4211male36.001PC 17755512.3292B51 B53 B55C3[null]
4311female58.001PC 17755512.3292B51 B53 B55C3[null]
4411male11.012113760120.0B96 B98S4[null]
4511female76.0101987778.85C46S6[null]
4611female[null]0111350555.0E33S6[null]
4711female39.011PC 1775683.1583E49C14[null]
4811female27.012F.C. 1275052.0B71S3[null]
4911female[null]0017421110.8833[null]C4[null]
5011female35.000113503211.5C130C4[null]
5111female22.00111237859.4[null]C7[null]
5211female25.0101176555.4417E50C5[null]
5311male48.010PC 1757276.7292D33C3[null]
5411female35.0103697383.475C83SD[null]
5511male27.000PC 1757276.7292D49C3[null]
5611female24.0001176783.1583C54C7[null]
5711female52.0111274993.5B69S3[null]
5811female44.00111136157.9792B18C4[null]
5911female15.00124160211.3375B5S2[null]
6011male30.0101323657.75C78C11[null]
6111female31.01035273113.275D36C6[null]
6211female39.000PC 17758108.9C105C8[null]
6311female22.00111350961.9792B36C5[null]
6411male52.00011378630.5C104S6[null]
6511female43.00124160211.3375B3S2[null]
6611female33.00011015286.5B77S8[null]
6711male45.01116966134.5E34C3[null]
6811female40.01116966134.5E34C3[null]
6911male48.0101999652.0C126S5 7[null]
7011female[null]00PC 1758579.2[null]CD[null]
7111female35.000PC 17755512.3292[null]C3[null]
7211female60.01011081375.25D37C5[null]
7311male21.001PC 1759761.3792[null]CA[null]
7420male23.000C.A. 3103010.5[null]S[null][null]
7520male28.00024435826.0[null]S[null][null]
7620male60.0112975039.0[null]S[null][null]
7720female44.01024425226.0[null]S[null][null]
7820male29.010200326.0[null]S[null][null]
7920male18.000S.O.C. 1487973.5[null]S[null][null]
8020male18.000S.O.C. 1487973.5[null]S[null][null]
8120male54.0002840326.0[null]S[null][null]
8220male18.00023617113.0[null]S[null][null]
8320male36.00022923613.0[null]S[null]236
8420male34.0102866421.0[null]S[null][null]
8520male21.0102813311.5[null]S[null][null]
8620male21.0102813411.5[null]S[null][null]
8720male24.00023386613.0[null]S[null]155
8820male34.0001223313.0[null]S[null][null]
8920male30.00025065313.0[null]S[null]75
9020male44.00024874613.0[null]S[null]35
9120male49.01222084565.0[null]S[null][null]
9220male21.020S.O.C. 1487973.5[null]S[null][null]
9320male21.000S.O.C. 1487973.5[null]S[null][null]
9420female60.0102406526.0[null]S[null][null]
9520male24.020C.A. 3102931.5[null]S[null][null]
9620male22.020C.A. 3102931.5[null]S[null][null]
9720male35.00023373412.35[null]Q[null][null]
9820male31.000C.A. 1872310.5[null]S[null]165
9920male36.000SC/Paris 216312.875DC[null][null]
10020male[null]00SC/A.3 286115.5792[null]C[null][null]
Rows: 1-100 | Columns: 14

Note

VerticaPy offers a wide range of sample datasets that are ideal for training and testing purposes. You can explore the full list of available datasets in the Datasets, which provides detailed information on each dataset and how to use them effectively. These datasets are invaluable resources for honing your data analysis and machine learning skills within the VerticaPy environment.

Let’s convert the vDataFrame to a pandas.DataFrame.

pandas_df = data.to_pandas()
display(pandas_df)
pclass survived name sex age sibsp parch ticket fare cabin embarked boat body home.dest
0 1 0 Artagaveytia, Mr. Ramon male 71.000 0 0 PC 17609 49.50420 None C None 22.0 Montevideo, Uruguay
1 1 0 Blackwell, Mr. Stephen Weart male 45.000 0 0 113784 35.50000 T S None NaN Trenton, NJ
2 1 0 Cairns, Mr. Alexander male None 0 0 113798 31.00000 None S None NaN None
... ... ... ... ... ... ... ... ... ... ... ... ... ... ...
1231 3 1 Whabee, Mrs. George Joseph (Shawneene Abi-Saab) female 38.000 0 0 2688 7.22920 None C C NaN None
1232 3 1 de Messemaeker, Mr. Guillaume Joseph male 36.500 1 0 345572 17.40000 None S 15 NaN Tampico, MT
1233 3 1 de Messemaeker, Mrs. Guillaume Joseph (Emma) female 36.000 1 0 345572 17.40000 None S 13 NaN Tampico, MT

Now, we will ingest the pandas.DataFrame into the Vertica database.

from verticapy.core.parsers import read_pandas

read_pandas(
    df = pandas_df,
    name = "titanic_pandas",
    schema = "public",
)
pclass survived name sex age sibsp parch ticket fare cabin embarked boat body home.dest
0 1 0 Artagaveytia, Mr. Ramon male 71.000 0 0 PC 17609 49.50420 None C None 22.0 Montevideo, Uruguay
1 1 0 Blackwell, Mr. Stephen Weart male 45.000 0 0 113784 35.50000 T S None NaN Trenton, NJ
2 1 0 Cairns, Mr. Alexander male None 0 0 113798 31.00000 None S None NaN None
3 1 0 Carrau, Mr. Jose Pedro male 17.000 0 0 113059 47.10000 None S None NaN Montevideo, Uruguay
4 1 0 Clark, Mr. Walter Miller male 27.000 1 0 13508 136.77920 C89 C None NaN Los Angeles, CA
... ... ... ... ... ... ... ... ... ... ... ... ... ... ...
1229 3 1 Touma, Mrs. Darwis (Hanne Youssef Razi) female 29.000 0 2 2650 15.24580 None C C NaN None
1230 3 1 Turkula, Mrs. (Hedwig) female 63.000 0 0 4134 9.58750 None S 15 NaN None
1231 3 1 Whabee, Mrs. George Joseph (Shawneene Abi-Saab) female 38.000 0 0 2688 7.22920 None C C NaN None
1232 3 1 de Messemaeker, Mr. Guillaume Joseph male 36.500 1 0 345572 17.40000 None S 15 NaN Tampico, MT
1233 3 1 de Messemaeker, Mrs. Guillaume Joseph (Emma) female 36.000 1 0 345572 17.40000 None S 13 NaN Tampico, MT

1234 rows × 14 columns

Let’s specify data types using “dtypes” parameter.

read_pandas(
    df = pandas_df,
    name = "titanic_pandas_dtypes",
    schema = "public",
    dtype = {
        "pclass": "Integer",
        "survived": "Integer",
        "name": "Varchar(164)",
        "sex": "Varchar(20)",
        "age": "Numeric(6,3)",
        "sibsp": "Integer",
        "parch": "Integer",
        "ticket": "Varchar(36)",
        "fare": "Numeric(10,5)",
        "cabin": "Varchar(30)",
        "embarked": "Varchar(20)",
        "boat": "Varchar(100)",
        "body": "Integer",
        "home.dest": "Varchar(100)",
    },
)
pclass survived name sex age sibsp parch ticket fare cabin embarked boat body home.dest
0 1 0 Artagaveytia, Mr. Ramon male 71.000 0 0 PC 17609 49.50420 None C None 22.0 Montevideo, Uruguay
1 1 0 Blackwell, Mr. Stephen Weart male 45.000 0 0 113784 35.50000 T S None NaN Trenton, NJ
2 1 0 Cairns, Mr. Alexander male None 0 0 113798 31.00000 None S None NaN None
3 1 0 Carrau, Mr. Jose Pedro male 17.000 0 0 113059 47.10000 None S None NaN Montevideo, Uruguay
4 1 0 Clark, Mr. Walter Miller male 27.000 1 0 13508 136.77920 C89 C None NaN Los Angeles, CA
... ... ... ... ... ... ... ... ... ... ... ... ... ... ...
1229 3 1 Touma, Mrs. Darwis (Hanne Youssef Razi) female 29.000 0 2 2650 15.24580 None C C NaN None
1230 3 1 Turkula, Mrs. (Hedwig) female 63.000 0 0 4134 9.58750 None S 15 NaN None
1231 3 1 Whabee, Mrs. George Joseph (Shawneene Abi-Saab) female 38.000 0 0 2688 7.22920 None C C NaN None
1232 3 1 de Messemaeker, Mr. Guillaume Joseph male 36.500 1 0 345572 17.40000 None S 15 NaN Tampico, MT
1233 3 1 de Messemaeker, Mrs. Guillaume Joseph (Emma) female 36.000 1 0 345572 17.40000 None S 13 NaN Tampico, MT

1234 rows × 14 columns

Important

A limited number of rows, determined by the parse_nrows parameter, is ingested. If your dataset is large and you want to ingest the entire dataset, increase its value.

Note

During the ingestion process, an intermediate CSV file is created. You can retrieve its location by using the temp_path parameter.

Note

If you want to ingest into an existing table, set the insert parameter to True.

See also

read_avro() : Ingests a AVRO file into the Vertica DB.
read_csv() : Ingests a CSV file into the Vertica DB.
read_file() : Ingests an input file into the Vertica DB.
read_json() : Ingests a JSON file into the Vertica DB.