bigframes.pandas.Index

class bigframes.pandas.Index(data=None, dtype=None, *, name=None, session=None)

Immutable sequence used for indexing and alignment.

The basic object storing axis labels for all objects.

Parameters:

• data (pandas.Series | pandas.Index | bigframes.series.Series | bigframes.core.indexes.base.Index) – Labels (1-dimensional).

• dtype – Data type for the output Index. If not specified, this will be inferred from data.

• name – Name to be stored in the index.

• session (Optional[bigframes.session.Session]) – BigQuery DataFrames session where queries are run. If not set, a default session is used.

Attributes

T	Return the transpose, which is by definition self.
dtype	Return the dtype object of the underlying data.
dtypes	Return the dtypes as a Series for the underlying MultiIndex.
empty	Returns True if the Index is empty, otherwise returns False.
has_duplicates	Check if the Index has duplicate values.
is_monotonic_decreasing	Return a boolean if the values are equal or decreasing.
is_monotonic_increasing	Return a boolean if the values are equal or increasing.
is_unique	Return if the index has unique values.
name	Returns Index name.
names	Returns the names of the Index.
ndim	Number of dimensions of the underlying data, by definition 1.
nlevels	Integer number of levels in this MultiIndex
query_job	BigQuery job metadata for the most recent query.
shape	Return a tuple of the shape of the underlying data.
size	Return the number of elements in the underlying data.
str	Vectorized string functions for Series and Index.
values	Return an array representing the data in the Index.

Methods

__init__()
all()	Return whether all elements are Truthy.
any()	Return whether any element is Truthy.
argmax()	Return int position of the largest value in the Series.
argmin()	Return int position of the smallest value in the series.
astype(dtype, *[, errors])	Create an Index with values cast to dtypes.
copy([name])	Make a copy of this object.
drop(labels)	Make new Index with passed list of labels deleted.
drop_duplicates(*[, keep])	Return Index with duplicate values removed.
dropna([how])	Return Index without NA/NaN values.
fillna([value])	Fill NA (NULL in BigQuery) values using the specified method.
from_frame(frame)	Make a MultiIndex from a DataFrame.
get_level_values(level)	Return an Index of values for requested level.
get_loc(key)	Get integer location, slice or boolean mask for requested label.
isin(values)	Return a boolean array where the index values are in values.
item()	Return the first element of the underlying data as a Python scalar.
max()	Return the maximum value of the Index.
min()	Return the minimum value of the Index.
nunique()	Return number of unique elements in the object.
rename()	Alter Index or MultiIndex name.
sort_values(*[, inplace, ascending, na_position])	Return a sorted copy of the index.
to_list(*[, allow_large_results])
to_numpy([dtype, allow_large_results])	A NumPy ndarray representing the values in this Series or Index.
to_pandas()	Gets the Index as a pandas Index.
to_series([index, name])	Create a Series with both index and values equal to the index keys.
transpose()	Return the transpose, which is by definition self.
unique([level])	Returns unique values in the index.
value_counts([normalize, sort, ascending, ...])	Return a Series containing counts of unique values.