def connect(**kwargs):
"""
A wrapper around nfldb.connect.
Returns a `psycopg2._psycopg.connection` object from the
`psycopg2.connect` function. If database is `None`, then `connect`
will look for a configuration file using `nfldb.config` with
`config_path`. Otherwise, the connection will use the parameters
given.
If `database` is `None` and no config file can be found, then an
`IOError` exception is raised.
This function will also compare the current schema version of the
database against the API version `nfldb.api_version` and assert
that they are equivalent. If the schema library version is less
than the the API version, then the schema will be automatically
upgraded. If the schema version is newer than the library version,
then this function will raise an assertion error. An assertion
error will also be raised if the schema version is 0 and the
database is not empty.
In addition, a similar updating will be performed for nfldbproj.
N.B. The `timezone` parameter should be set to a value that
PostgreSQL will accept. Select from the `pg_timezone_names` view
to get a list of valid time zones.
"""
conn = nfldb_connect(**kwargs)
# Migration.
nfldbproj_sversion = nfldbproj_schema_version(conn)
assert nfldbproj_sversion <= nfldbproj_api_version, \
'nfldbproj library version {} is older than schema with version {}'.format(
nfldbproj_api_version, nfldbproj_sversion
)
assert api_version == nfldb_api_version, \
'nfldbproj expects nfldb version {}, encountered nfldb version {}'.format(
nfldb_api_version, api_version
)
assert nfldbproj_sversion > 0 or (nfldbproj_sversion == 0 and _nfldbproj_is_empty(conn)), \
'nfldbproj schema has version 0 but is not empty'
set_timezone(conn, 'UTC')
_migrate_nfldbproj(conn, nfldbproj_api_version)
if kwargs.get('timezone'):
set_timezone(conn, kwargs['timezone'])
# Bind SQL -> Python casting functions for additional types.
_bind_type(conn, 'fantasy_position',
_Enum._pg_cast(ProjEnums.fantasy_position))
_bind_type(conn, 'proj_scope', _Enum._pg_cast(ProjEnums.proj_scope))
return conn
def connect(**kwargs):
"""
A wrapper around nfldb.connect.
Returns a `psycopg2._psycopg.connection` object from the
`psycopg2.connect` function. If database is `None`, then `connect`
will look for a configuration file using `nfldb.config` with
`config_path`. Otherwise, the connection will use the parameters
given.
If `database` is `None` and no config file can be found, then an
`IOError` exception is raised.
This function will also compare the current schema version of the
database against the API version `nfldb.api_version` and assert
that they are equivalent. If the schema library version is less
than the the API version, then the schema will be automatically
upgraded. If the schema version is newer than the library version,
then this function will raise an assertion error. An assertion
error will also be raised if the schema version is 0 and the
database is not empty.
In addition, a similar updating will be performed for nfldbproj.
N.B. The `timezone` parameter should be set to a value that
PostgreSQL will accept. Select from the `pg_timezone_names` view
to get a list of valid time zones.
"""
conn = nfldb_connect(**kwargs)
# Migration.
nfldbproj_sversion = nfldbproj_schema_version(conn)
assert nfldbproj_sversion <= nfldbproj_api_version, \
'nfldbproj library version {} is older than schema with version {}'.format(
nfldbproj_api_version, nfldbproj_sversion
)
assert api_version == nfldb_api_version, \
'nfldbproj expects nfldb version {}, encountered nfldb version {}'.format(
nfldb_api_version, api_version
)
assert nfldbproj_sversion > 0 or (nfldbproj_sversion == 0 and _nfldbproj_is_empty(conn)), \
'nfldbproj schema has version 0 but is not empty'
set_timezone(conn, 'UTC')
_migrate_nfldbproj(conn, nfldbproj_api_version)
if kwargs.get('timezone'):
set_timezone(conn, kwargs['timezone'])
# Bind SQL -> Python casting functions for additional types.
_bind_type(conn, 'fantasy_position', _Enum._pg_cast(ProjEnums.fantasy_position))
_bind_type(conn, 'proj_scope', _Enum._pg_cast(ProjEnums.proj_scope))
return conn
def connect(database=None, user=None, password=None, host=None, port=None,
timezone=None, config_path=''):
"""
Returns a `psycopg2._psycopg.connection` object from the
`psycopg2.connect` function. If database is `None`, then `connect`
will look for a configuration file using `nfldb.config` with
`config_path`. Otherwise, the connection will use the parameters
given.
If `database` is `None` and no config file can be found, then an
`IOError` exception is raised.
This function will also compare the current schema version of the
database against the API version `nfldb.api_version` and assert
that they are equivalent. If the schema library version is less
than the the API version, then the schema will be automatically
upgraded. If the schema version is newer than the library version,
then this function will raise an assertion error. An assertion
error will also be raised if the schema version is 0 and the
database is not empty.
N.B. The `timezone` parameter should be set to a value that
PostgreSQL will accept. Select from the `pg_timezone_names` view
to get a list of valid time zones.
"""
if database is None:
conf, tried = config(config_path=config_path)
if conf is None:
raise IOError("Could not find valid configuration file. "
"Tried the following paths: %s" % tried)
timezone, database = conf['timezone'], conf['database']
user, password = conf['user'], conf['password']
host, port = conf['host'], conf['port']
conn = psycopg2.connect(database=database, user=user, password=password,
host=host, port=port)
# Start the migration. Make sure if this is the initial setup that
# the DB is empty.
sversion = schema_version(conn)
assert sversion <= api_version, \
'Library with version %d is older than the schema with version %d' \
% (api_version, sversion)
assert sversion > 0 or (sversion == 0 and _is_empty(conn)), \
'Schema has version 0 but is not empty.'
set_timezone(conn, 'UTC')
_migrate(conn, api_version)
if timezone is not None:
set_timezone(conn, timezone)
# Bind SQL -> Python casting functions.
from nfldb.types import Clock, _Enum, Enums, FieldPosition, PossessionTime
_bind_type(conn, 'game_phase', _Enum._pg_cast(Enums.game_phase))
_bind_type(conn, 'season_phase', _Enum._pg_cast(Enums.season_phase))
_bind_type(conn, 'game_day', _Enum._pg_cast(Enums.game_day))
_bind_type(conn, 'player_pos', _Enum._pg_cast(Enums.player_pos))
_bind_type(conn, 'player_status', _Enum._pg_cast(Enums.player_status))
_bind_type(conn, 'game_time', Clock._pg_cast)
_bind_type(conn, 'pos_period', PossessionTime._pg_cast)
_bind_type(conn, 'field_pos', FieldPosition._pg_cast)
return conn
def connect(database=None, user=None, password=None, host=None, port=None,
timezone=None, config_path=''):
"""
Returns a `psycopg2._psycopg.connection` object from the
`psycopg2.connect` function. If database is `None`, then `connect`
will look for a configuration file using `nfldb.config` with
`config_path`. Otherwise, the connection will use the parameters
given.
If `database` is `None` and no config file can be found, then an
`IOError` exception is raised.
This function will also compare the current schema version of the
database against the API version `nfldb.api_version` and assert
that they are equivalent. If the schema library version is less
than the the API version, then the schema will be automatically
upgraded. If the schema version is newer than the library version,
then this function will raise an assertion error. An assertion
error will also be raised if the schema version is 0 and the
database is not empty.
N.B. The `timezone` parameter should be set to a value that
PostgreSQL will accept. Select from the `pg_timezone_names` view
to get a list of valid time zones.
"""
if database is None:
conf = config(config_path=config_path)
if conf is None:
raise IOError("Could not find valid configuration file.")
timezone, database = conf['timezone'], conf['database']
user, password = conf['user'], conf['password']
host, port = conf['host'], conf['port']
conn = psycopg2.connect(database=database, user=user, password=password,
host=host, port=port)
# Start the migration. Make sure if this is the initial setup that
# the DB is empty.
sversion = schema_version(conn)
assert sversion <= api_version, \
'Library with version %d is older than the schema with version %d' \
% (api_version, sversion)
assert sversion > 0 or (sversion == 0 and _is_empty(conn)), \
'Schema has version 0 but is not empty.'
set_timezone(conn, 'UTC')
_migrate(conn, api_version)
if timezone is not None:
set_timezone(conn, timezone)
# Bind SQL -> Python casting functions.
from nfldb.types import Clock, _Enum, Enums, FieldPosition, PossessionTime
_bind_type(conn, 'game_phase', _Enum._pg_cast(Enums.game_phase))
_bind_type(conn, 'season_phase', _Enum._pg_cast(Enums.season_phase))
_bind_type(conn, 'game_day', _Enum._pg_cast(Enums.game_day))
_bind_type(conn, 'player_pos', _Enum._pg_cast(Enums.player_pos))
_bind_type(conn, 'player_status', _Enum._pg_cast(Enums.player_status))
_bind_type(conn, 'game_time', Clock._pg_cast)
_bind_type(conn, 'pos_period', PossessionTime._pg_cast)
_bind_type(conn, 'field_pos', FieldPosition._pg_cast)
return conn
