nudb_use.datasets package¶
Subpackages¶
nudb_use.datasets.avslutta module¶
nudb_use.datasets.bof module¶
nudb_use.datasets.eksamen module¶
nudb_use.datasets.external module¶
nudb_use.datasets.igang module¶
nudb_use.datasets.macros module¶
nudb_use.datasets.microdata module¶
- class MicroData(name, *args, **kwargs)¶
Bases:
NudbDataLazy representation of a Microdata variable as an NUDB dataset.
- Parameters:
name (
str) – Name of the microdata variable.*args (
Any) – Unnamed arguments passed on to the dataset generator.**kwargs (
Any) – Named arguments passed on to the dataset generator.
- Raises:
ValueError – If the variable name isn’t recognized.
- show_available_microdata_variables()¶
Get available Microdata variables.
- Returns:
A list with variable names.
- Return type:
list[str]
nudb_use.datasets.nudb_data module¶
- class NudbData(name, attach_using_init=True, *args, **kwargs)¶
Bases:
objectLazy representation of a NUDB dataset.
- Parameters:
name (
str) – Name of the dataset.attach_using_init (
bool) – Should dataset be attached to the internal database?*args (
Any) – Unnamed arguments passed on to the dataset generator.**kwargs (
Any) – Named arguments passed on to the dataset generator.
- Raises:
ValueError – If the dataset name isn’t recognized.
- as_name(expr)¶
Specify (inner part) of the AS statement in SQL query.
- Return type:
- Parameters:
expr (str)
- cross_join(data, as_name='')¶
Specify (inner part) of the CROSS JOIN statement in SQL query.
- Parameters:
data (
str|DataFrame|NudbData) – Input data. Either an NudbData object, a string indicating the name of the NudbData-datasett (e.g., “avslutta”), or a pandas DataFrame.as_name (
str) – Should the dataset be given an alias in the join (e.g., “T2”)?
- Returns:
An NudbData object.
- Return type:
- df()¶
Return dataset as a pandas DataFrame.
- Return type:
DataFrame
- execute(expr)¶
Use execute method of database connection.
- Return type:
Any- Parameters:
expr (str)
- classmethod from_parquet(path, name=None, force=False, **kwargs)¶
Create NudbData object from a path of a parquet file.
- Return type:
- Parameters:
path (str | Path)
name (str | None)
force (bool)
kwargs (Any)
- full_join(data, as_name='')¶
Specify (inner part) of the FULL JOIN statement in SQL query.
- Parameters:
data (
str|DataFrame|NudbData) – Input data. Either an NudbData object, a string indicating the name of the NudbData-datasett (e.g., “avslutta”), or a pandas DataFrame.as_name (
str) – Should the dataset be given an alias in the join (e.g., “T2”)?
- Returns:
An NudbData object.
- Return type:
- get_available_cols()¶
Get available columns in dataset.
- Return type:
list[str|Any]
- inner_join(data, as_name='')¶
Specify (inner part) of the INNER JOIN statement in SQL query.
- Parameters:
data (
str|DataFrame|NudbData) – Input data. Either an NudbData object, a string indicating the name of the NudbData-datasett (e.g., “avslutta”), or a pandas DataFrame.as_name (
str) – Should the dataset be given an alias in the join (e.g., “T2”)?
- Returns:
An NudbData object.
- Return type:
- join(data, how='inner', as_name=None)¶
Specify (inner part) of the JOIN statement in SQL query.
- Parameters:
data (
str|DataFrame|NudbData) – Input data. Either an NudbData object, a string indicating the name of the NudbData-datasett (e.g., “avslutta”), or a pandas DataFrame.how (
str) – A string indicator the join type.as_name (
str|None) – Should the dataset be given an alias in the join (e.g., “T2”)?
- Returns:
An NudbData object.
- Return type:
- Raises:
ValueError – If how is not a supported join type.
- left_join(data, as_name='')¶
Specify (inner part) of the LEFT JOIN statement in SQL query.
- Parameters:
data (
str|DataFrame|NudbData) – Input data. Either an NudbData object, a string indicating the name of the NudbData-datasett (e.g., “avslutta”), or a pandas DataFrame.as_name (
str) – Should the dataset be given an alias in the join (e.g., “T2”)?
- Returns:
An NudbData object.
- Return type:
- limit(expr)¶
Specify (inner part) of the LIMIT statement in SQL query.
- Return type:
- Parameters:
expr (str | int)
- on(*exprs)¶
Specify (inner part) of the ON statement in SQL query.
- Return type:
- Parameters:
exprs (str)
- right_join(data, as_name='')¶
Specify (inner part) of the RIGHT JOIN statement in SQL query.
- Parameters:
data (
str|DataFrame|NudbData) – Input data. Either an NudbData object, a string indicating the name of the NudbData-datasett (e.g., “avslutta”), or a pandas DataFrame.as_name (
str) – Should the dataset be given an alias in the join (e.g., “T2”)?
- Returns:
An NudbData object.
- Return type:
- select(*exprs)¶
Specify (inner part) of the SELECT statement in SQL query.
- Return type:
- Parameters:
exprs (str)
- select_distinct(*exprs)¶
Specify (inner part) of the SELECT DISTINCT statement in SQL query.
- Return type:
- Parameters:
exprs (str)
- self_join(data, as_name='')¶
Specify (inner part) of the SELF JOIN statement in SQL query.
- Parameters:
data (
str|DataFrame|NudbData) – Input data. Either an NudbData object, a string indicating the name of the NudbData-datasett (e.g., “avslutta”), or a pandas DataFrame.as_name (
str) – Should the dataset be given an alias in the join (e.g., “T2”)?
- Returns:
An NudbData object.
- Return type:
- sql(expr=None)¶
Use sql method of database connection.
- Return type:
Any- Parameters:
expr (str | None)
- using(*exprs)¶
Specify (inner part) of the USING statement in SQL query.
- Return type:
- Parameters:
exprs (str)
nudb_use.datasets.nudb_database module¶
- reset_nudb_database()¶
Reset (I.e., clear) the internal database.
- Return type:
None
- show_nudb_datasets(show_private=False)¶
Get datasets in _nudb_database.
- Parameters:
show_private (
bool) – Should private datasets be shown?- Returns:
A list with dataset names.
- Return type:
list[str]