-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathrepo_config.py
More file actions
735 lines (595 loc) · 32 KB
/
repo_config.py
File metadata and controls
735 lines (595 loc) · 32 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
import logging
import os
import warnings
from pathlib import Path
from typing import Any, Dict, Optional
import yaml
from pydantic import (
BaseModel,
ConfigDict,
Field,
StrictBool,
StrictInt,
StrictStr,
ValidationError,
ValidationInfo,
field_validator,
model_validator,
)
from feast.errors import (
FeastFeatureServerTypeInvalidError,
FeastInvalidAuthConfigClass,
FeastOfflineStoreInvalidName,
FeastOnlineStoreInvalidName,
FeastRegistryNotSetError,
FeastRegistryTypeInvalidError,
)
from feast.importer import import_class
from feast.permissions.auth.auth_type import AuthType
warnings.simplefilter("once", RuntimeWarning)
_logger = logging.getLogger(__name__)
# These dict exists so that:
# - existing values for the online store type in featurestore.yaml files continue to work in a backwards compatible way
# - first party and third party implementations can use the same class loading code path.
REGISTRY_CLASS_FOR_TYPE = {
"file": "feast.infra.registry.registry.Registry",
"sql": "feast.infra.registry.sql.SqlRegistry",
"snowflake.registry": "feast.infra.registry.snowflake.SnowflakeRegistry",
"remote": "feast.infra.registry.remote.RemoteRegistry",
}
BATCH_ENGINE_CLASS_FOR_TYPE = {
"local": "feast.infra.compute_engines.local.compute.LocalComputeEngine",
"snowflake.engine": "feast.infra.compute_engines.snowflake.snowflake_engine.SnowflakeComputeEngine",
"lambda": "feast.infra.compute_engines.aws_lambda.lambda_engine.LambdaComputeEngine",
"k8s": "feast.infra.compute_engines.kubernetes.k8s_engine.KubernetesComputeEngine",
"spark.engine": "feast.infra.compute_engines.spark.compute.SparkComputeEngine",
"ray.engine": "feast.infra.compute_engines.ray.compute.RayComputeEngine",
}
LEGACY_ONLINE_STORE_CLASS_FOR_TYPE = {
"feast.infra.online_stores.contrib.postgres.PostgreSQLOnlineStore": "feast.infra.online_stores.postgres_online_store.PostgreSQLOnlineStore",
"feast.infra.online_stores.contrib.hbase_online_store.hbase.HbaseOnlineStore": "feast.infra.online_stores.hbase_online_store.hbase.HbaseOnlineStore",
"feast.infra.online_stores.contrib.cassandra_online_store.cassandra_online_store.CassandraOnlineStore": "feast.infra.online_stores.cassandra_online_store.cassandra_online_store.CassandraOnlineStore",
"feast.infra.online_stores.contrib.mysql_online_store.mysql.MySQLOnlineStore": "feast.infra.online_stores.mysql_online_store.mysql.MySQLOnlineStore",
"feast.infra.online_stores.contrib.hazelcast_online_store.hazelcast_online_store.HazelcastOnlineStore": "feast.infra.online_stores.hazelcast_online_store.hazelcast_online_store.HazelcastOnlineStore",
"feast.infra.online_stores.contrib.elasticsearch.ElasticSearchOnlineStore": "feast.infra.online_stores.elasticsearch_online_store.elasticsearch.ElasticSearchOnlineStore",
"feast.infra.online_stores.contrib.singlestore_online_store.singlestore.SingleStoreOnlineStore": "feast.infra.online_stores.singlestore_online_store.singlestore.SingleStoreOnlineStore",
"feast.infra.online_stores.contrib.qdrant.QdrantOnlineStore": "feast.infra.online_stores.qdrant_online_store.qdrant.QdrantOnlineStore",
"feast.infra.online_stores.contrib.milvus.MilvusOnlineStore": "feast.infra.online_stores.milvus.MilvusOnlineStore",
}
ONLINE_STORE_CLASS_FOR_TYPE = {
"sqlite": "feast.infra.online_stores.sqlite.SqliteOnlineStore",
"datastore": "feast.infra.online_stores.datastore.DatastoreOnlineStore",
"redis": "feast.infra.online_stores.redis.RedisOnlineStore",
"dynamodb": "feast.infra.online_stores.dynamodb.DynamoDBOnlineStore",
"snowflake.online": "feast.infra.online_stores.snowflake.SnowflakeOnlineStore",
"bigtable": "feast.infra.online_stores.bigtable.BigtableOnlineStore",
"postgres": "feast.infra.online_stores.postgres_online_store.postgres.PostgreSQLOnlineStore",
"hbase": "feast.infra.online_stores.hbase_online_store.hbase.HbaseOnlineStore",
"cassandra": "feast.infra.online_stores.cassandra_online_store.cassandra_online_store.CassandraOnlineStore",
"mysql": "feast.infra.online_stores.mysql_online_store.mysql.MySQLOnlineStore",
"hazelcast": "feast.infra.online_stores.hazelcast_online_store.hazelcast_online_store.HazelcastOnlineStore",
"elasticsearch": "feast.infra.online_stores.elasticsearch_online_store.elasticsearch.ElasticSearchOnlineStore",
"remote": "feast.infra.online_stores.remote.RemoteOnlineStore",
"singlestore": "feast.infra.online_stores.singlestore_online_store.singlestore.SingleStoreOnlineStore",
"qdrant": "feast.infra.online_stores.qdrant_online_store.qdrant.QdrantOnlineStore",
"couchbase.online": "feast.infra.online_stores.couchbase_online_store.couchbase.CouchbaseOnlineStore",
"milvus": "feast.infra.online_stores.milvus_online_store.milvus.MilvusOnlineStore",
"mongodb": "feast.infra.online_stores.mongodb_online_store.MongoDBOnlineStore",
"hybrid": "feast.infra.online_stores.hybrid_online_store.hybrid_online_store.HybridOnlineStore",
**LEGACY_ONLINE_STORE_CLASS_FOR_TYPE,
}
OFFLINE_STORE_CLASS_FOR_TYPE = {
"file": "feast.infra.offline_stores.dask.DaskOfflineStore",
"dask": "feast.infra.offline_stores.dask.DaskOfflineStore",
"bigquery": "feast.infra.offline_stores.bigquery.BigQueryOfflineStore",
"redshift": "feast.infra.offline_stores.redshift.RedshiftOfflineStore",
"snowflake.offline": "feast.infra.offline_stores.snowflake.SnowflakeOfflineStore",
"spark": "feast.infra.offline_stores.contrib.spark_offline_store.spark.SparkOfflineStore",
"trino": "feast.infra.offline_stores.contrib.trino_offline_store.trino.TrinoOfflineStore",
"postgres": "feast.infra.offline_stores.contrib.postgres_offline_store.postgres.PostgreSQLOfflineStore",
"athena": "feast.infra.offline_stores.contrib.athena_offline_store.athena.AthenaOfflineStore",
"mssql": "feast.infra.offline_stores.contrib.mssql_offline_store.mssql.MsSqlServerOfflineStore",
"duckdb": "feast.infra.offline_stores.duckdb.DuckDBOfflineStore",
"remote": "feast.infra.offline_stores.remote.RemoteOfflineStore",
"couchbase.offline": "feast.infra.offline_stores.contrib.couchbase_offline_store.couchbase.CouchbaseColumnarOfflineStore",
"clickhouse": "feast.infra.offline_stores.contrib.clickhouse_offline_store.clickhouse.ClickhouseOfflineStore",
"ray": "feast.infra.offline_stores.contrib.ray_offline_store.ray.RayOfflineStore",
}
FEATURE_SERVER_CONFIG_CLASS_FOR_TYPE = {
"local": "feast.infra.feature_servers.local_process.config.LocalFeatureServerConfig",
"mcp": "feast.infra.mcp_servers.mcp_config.McpFeatureServerConfig",
}
ALLOWED_AUTH_TYPES = ["no_auth", "kubernetes", "oidc"]
AUTH_CONFIGS_CLASS_FOR_TYPE = {
"no_auth": "feast.permissions.auth_model.NoAuthConfig",
"kubernetes": "feast.permissions.auth_model.KubernetesAuthConfig",
"oidc": "feast.permissions.auth_model.OidcAuthConfig",
"oidc_client": "feast.permissions.auth_model.OidcClientAuthConfig",
}
class FeastBaseModel(BaseModel):
"""Feast Pydantic Configuration Class"""
model_config = ConfigDict(arbitrary_types_allowed=True, extra="allow")
class FeastConfigBaseModel(BaseModel):
"""Feast Pydantic Configuration Class"""
model_config = ConfigDict(arbitrary_types_allowed=True, extra="forbid")
class RegistryConfig(FeastBaseModel):
"""Metadata Store Configuration. Configuration that relates to reading from and writing to the Feast registry."""
registry_type: StrictStr = "file"
""" str: Provider name or a class name that implements Registry."""
registry_store_type: Optional[StrictStr] = None
""" str: Provider name or a class name that implements RegistryStore. """
path: StrictStr = ""
""" str: Path to metadata store.
If registry_type is 'file', then an be a local path, or remote object storage path, e.g. a GCS URI
If registry_type is 'sql', then this is a database URL as expected by SQLAlchemy """
cache_ttl_seconds: StrictInt = 600
"""int: The cache TTL is the amount of time registry state will be cached in memory. If this TTL is exceeded then
the registry will be refreshed when any feature store method asks for access to registry state. The TTL can be
set to infinity by setting TTL to 0 seconds, which means the cache will only be loaded once and will never
expire. Users can manually refresh the cache by calling feature_store.refresh_registry() """
cache_mode: StrictStr = "sync"
"""str: Cache mode type. Possible options are 'sync' (immediate refresh after each write operation) and
'thread' (asynchronous background refresh at cache_ttl_seconds intervals). In 'sync' mode, registry changes
are immediately visible. In 'thread' mode, changes may take up to
cache_ttl_seconds to be visible."""
s3_additional_kwargs: Optional[Dict[str, str]] = None
""" Dict[str, str]: Extra arguments to pass to boto3 when writing the registry file to S3. """
purge_feast_metadata: StrictBool = False
""" bool: Stops using feast_metadata table and delete data from feast_metadata table.
Once this is set to True, it cannot be reverted back to False. Reverting back to False will
only reset the project but not all the projects"""
@field_validator("path")
def validate_path(cls, path: str, values: ValidationInfo) -> str:
if values.data.get("registry_type") == "sql":
if path.startswith("postgresql://"):
_logger.warning(
"The `path` of the `RegistryConfig` starts with a plain "
"`postgresql` string. We are updating this to `postgresql+psycopg` "
"to ensure that the `psycopg3` driver is used by `sqlalchemy`. If "
"you want to use `psycopg2` pass `postgresql+psycopg2` explicitely "
"to `path`. To silence this warning, pass `postgresql+psycopg` "
"explicitely to `path`."
)
return path.replace("postgresql://", "postgresql+psycopg://")
return path
class MaterializationConfig(BaseModel):
"""Configuration options for feature materialization behavior."""
pull_latest_features: StrictBool = False
""" bool: If true, feature retrieval jobs will only pull the latest feature values for each entity.
If false, feature retrieval jobs will pull all feature values within the specified time range. """
class OpenLineageConfig(FeastBaseModel):
"""Configuration for OpenLineage integration.
This enables automatic data lineage tracking for Feast operations like
materialization, feature retrieval, and registry changes.
Example configuration in feature_store.yaml:
openlineage:
enabled: true
transport_type: http
transport_url: http://localhost:5000
transport_endpoint: api/v1/lineage
namespace: feast
"""
enabled: StrictBool = False
""" bool: Whether OpenLineage integration is enabled. Defaults to False. """
transport_type: StrictStr = "console"
""" str: Type of transport (http, console, file, kafka). Defaults to console. """
transport_url: Optional[StrictStr] = None
""" str: URL for HTTP transport. Required when transport_type is 'http'. """
transport_endpoint: StrictStr = "api/v1/lineage"
""" str: API endpoint for HTTP transport. Defaults to 'api/v1/lineage'. """
api_key: Optional[StrictStr] = None
""" str: Optional API key for authentication with the lineage server. """
namespace: StrictStr = "feast"
""" str: Default namespace for Feast jobs and datasets. """
producer: StrictStr = "feast"
""" str: Producer identifier for OpenLineage events. """
emit_on_apply: StrictBool = True
""" bool: Emit lineage events when 'feast apply' is called. """
emit_on_materialize: StrictBool = True
""" bool: Emit lineage events during materialization. """
def to_openlineage_config(self):
"""Convert to feast.openlineage.OpenLineageConfig."""
from feast.openlineage.config import OpenLineageConfig as OLConfig
return OLConfig(
enabled=self.enabled,
transport_type=self.transport_type,
transport_url=self.transport_url,
transport_endpoint=self.transport_endpoint,
api_key=self.api_key,
namespace=self.namespace,
producer=self.producer,
emit_on_apply=self.emit_on_apply,
emit_on_materialize=self.emit_on_materialize,
)
class RepoConfig(FeastBaseModel):
"""Repo config. Typically loaded from `feature_store.yaml`"""
project: StrictStr
""" str: This acts as a Feast unique project identifier. This can be any alphanumeric string and can have '_' but can not start with '_'.
You can have multiple independent feature repositories deployed to the same cloud
provider account, as long as they have different project identifier.
"""
project_description: Optional[StrictStr] = None
""" str: Optional description of the project to provide context about the project's purpose and usage.
"""
provider: StrictStr = "local"
""" str: local or gcp or aws """
registry_config: Any = Field(alias="registry", default="data/registry.db")
""" Configures the registry.
Can be:
1. str: a path to a file based registry (a local path, or remote object storage path, e.g. a GCS URI)
2. RegistryConfig: A fully specified file based registry or SQL based registry
3. SnowflakeRegistryConfig: Using a Snowflake table to store the registry
"""
online_config: Any = Field(None, alias="online_store")
""" OnlineStoreConfig: Online store configuration (optional depending on provider) """
auth: Any = Field(None, alias="auth")
""" auth: Optional if the services needs the authentication against IDPs (optional depending on provider) """
offline_config: Any = Field(None, alias="offline_store")
""" OfflineStoreConfig: Offline store configuration (optional depending on provider) """
batch_engine_config: Any = Field(None, alias="batch_engine")
""" BatchMaterializationEngine: Batch materialization configuration (optional depending on provider)"""
feature_server: Optional[Any] = None
""" FeatureServerConfig: Feature server configuration (optional depending on provider) """
flags: Any = None
""" Flags (deprecated field): Feature flags for experimental features """
repo_path: Optional[Path] = None
"""When using relative path in FileSource path, this parameter is mandatory"""
entity_key_serialization_version: StrictInt = 3
""" Entity key serialization version: This version is used to control what serialization scheme is
used when writing data to the online store.
A value of 3 uses the latest serialization scheme, supported as of Feast 0.38.
Version Schemas:
v3: add entity_key value length to serialized bytes to enable deserialization, which can be used in retrieval of entity_key in document retrieval.
"""
coerce_tz_aware: Optional[bool] = True
""" If True, coerces entity_df timestamp columns to be timezone aware (to UTC by default). """
materialization_config: MaterializationConfig = Field(
MaterializationConfig(), alias="materialization"
)
""" MaterializationConfig: Configuration options for feature materialization behavior. """
openlineage_config: Optional[OpenLineageConfig] = Field(None, alias="openlineage")
""" OpenLineageConfig: Configuration for OpenLineage data lineage integration (optional). """
def __init__(self, **data: Any):
super().__init__(**data)
self._registry = None
if "registry" not in data:
raise FeastRegistryNotSetError()
self.registry_config = data["registry"]
self._offline_store = None
self.offline_config = data.get("offline_store", "dask")
self._online_store = None
self.online_config = data.get("online_store", "sqlite")
self._auth = None
if "auth" not in data:
self.auth = dict()
self.auth["type"] = AuthType.NONE.value
else:
self.auth = data.get("auth")
self._batch_engine = None
if "batch_engine" in data:
self.batch_engine_config = data["batch_engine"]
elif "batch_engine_config" in data:
self.batch_engine_config = data["batch_engine_config"]
else:
# Defaults to using local in-process materialization engine.
self.batch_engine_config = "local"
if isinstance(self.feature_server, Dict):
self.feature_server = get_feature_server_config_from_type(
self.feature_server["type"]
)(**self.feature_server)
# Initialize OpenLineage configuration
self._openlineage: Optional[OpenLineageConfig] = None
if "openlineage" in data:
self.openlineage_config = data["openlineage"]
if self.entity_key_serialization_version < 3:
warnings.warn(
"The serialization version below 3 are deprecated. "
"Specifying `entity_key_serialization_version` to 3 is recommended.",
DeprecationWarning,
)
@property
def registry(self):
if not self._registry:
if isinstance(self.registry_config, Dict):
if "registry_type" in self.registry_config:
self._registry = get_registry_config_from_type(
self.registry_config["registry_type"]
)(**self.registry_config)
else:
# This may be a custom registry store, which does not need a 'registry_type'
self._registry = RegistryConfig(**self.registry_config)
elif isinstance(self.registry_config, str):
# User passed in just a path to file registry
self._registry = get_registry_config_from_type("file")(
path=self.registry_config
)
elif self.registry_config:
self._registry = self.registry_config
return self._registry
@property
def offline_store(self):
if not self._offline_store:
if isinstance(self.offline_config, Dict):
self._offline_store = get_offline_config_from_type(
self.offline_config["type"]
)(**self.offline_config)
elif isinstance(self.offline_config, str):
self._offline_store = get_offline_config_from_type(
self.offline_config
)()
elif self.offline_config:
self._offline_store = self.offline_config
return self._offline_store
@property
def auth_config(self):
if not self._auth:
if isinstance(self.auth, Dict):
# treat this auth block as *client-side* OIDC when it matches
# 1) ROPG – username + password + client_secret
# 2) client-credentials – client_secret only
# 3) static token – token
is_oidc_client = self.auth.get("type") == AuthType.OIDC.value and (
(
"username" in self.auth
and "password" in self.auth
and "client_secret" in self.auth
) # 1
or (
"client_secret" in self.auth
and "username" not in self.auth
and "password" not in self.auth
) # 2
or ("token" in self.auth) # 3
)
self._auth = get_auth_config_from_type(
"oidc_client" if is_oidc_client else self.auth.get("type")
)(**self.auth)
elif isinstance(self.auth, str):
self._auth = get_auth_config_from_type(self.auth)()
elif self.auth:
self._auth = self.auth
return self._auth
@property
def online_store(self):
if not self._online_store:
if isinstance(self.online_config, Dict):
self._online_store = get_online_config_from_type(
self.online_config["type"]
)(**self.online_config)
elif isinstance(self.online_config, str):
self._online_store = get_online_config_from_type(self.online_config)()
elif self.online_config:
self._online_store = self.online_config
return self._online_store
@property
def batch_engine(self):
if not self._batch_engine:
if isinstance(self.batch_engine_config, Dict):
self._batch_engine = get_batch_engine_config_from_type(
self.batch_engine_config["type"]
)(**self.batch_engine_config)
elif isinstance(self.batch_engine_config, str):
self._batch_engine = get_batch_engine_config_from_type(
self.batch_engine_config
)()
elif self.batch_engine_config:
self._batch_engine = self._batch_engine
return self._batch_engine
@property
def openlineage(self) -> Optional[OpenLineageConfig]:
"""Get the OpenLineage configuration."""
if not self._openlineage:
if isinstance(self.openlineage_config, Dict):
self._openlineage = OpenLineageConfig(**self.openlineage_config)
elif self.openlineage_config:
self._openlineage = self.openlineage_config
return self._openlineage
@model_validator(mode="before")
def _validate_auth_config(cls, values: Any) -> Any:
from feast.permissions.auth_model import AuthConfig
if "auth" in values:
if isinstance(values["auth"], Dict):
if values["auth"].get("type") is None:
raise ValueError(
f"auth configuration is missing authentication type. Possible values={ALLOWED_AUTH_TYPES}"
)
elif values["auth"]["type"] not in ALLOWED_AUTH_TYPES:
raise ValueError(
f"auth configuration has invalid authentication type={values['auth']['type']}. Possible "
f"values={ALLOWED_AUTH_TYPES}"
)
elif isinstance(values["auth"], AuthConfig):
if values["auth"].type not in ALLOWED_AUTH_TYPES:
raise ValueError(
f"auth configuration has invalid authentication type={values['auth'].type}. Possible "
f"values={ALLOWED_AUTH_TYPES}"
)
return values
@model_validator(mode="before")
def _validate_online_store_config(cls, values: Any) -> Any:
# This method will validate whether the online store configurations are set correctly. This explicit validation
# is necessary because Pydantic Unions throw very verbose and cryptic exceptions. We also use this method to
# impute the default online store type based on the selected provider. For the time being this method should be
# considered tech debt until we can implement https://github.com/samuelcolvin/pydantic/issues/619 or a more
# granular configuration system
# Set empty online_store config if it isn't set explicitly
if "online_store" not in values:
values["online_store"] = dict()
# Skip if we aren't creating the configuration from a dict or online store is null or it is a string like "None" or "null"
if not isinstance(values["online_store"], Dict):
if isinstance(values["online_store"], str) and values[
"online_store"
].lower() in {"none", "null"}:
values["online_store"] = None
return values
# Set the default type
# This is only direct reference to a provider or online store that we should have
# for backwards compatibility.
if "type" not in values["online_store"]:
values["online_store"]["type"] = "sqlite"
online_store_type = values["online_store"]["type"]
# Validate the dict to ensure one of the union types match
try:
online_config_class = get_online_config_from_type(online_store_type)
online_config_class(**values["online_store"])
except ValidationError as e:
raise e
return values
@model_validator(mode="before")
@classmethod
def _validate_offline_store_config(cls, values: Any) -> Any:
# Set empty offline_store config if it isn't set explicitly
if "offline_store" not in values:
values["offline_store"] = dict()
# Skip if we aren't creating the configuration from a dict
if not isinstance(values["offline_store"], Dict):
return values
# Set the default type
if "type" not in values["offline_store"]:
values["offline_store"]["type"] = "dask"
offline_store_type = values["offline_store"]["type"]
# Validate the dict to ensure one of the union types match
try:
offline_config_class = get_offline_config_from_type(offline_store_type)
offline_config_class(**values["offline_store"])
except ValidationError as e:
raise e
return values
@model_validator(mode="before")
@classmethod
def _validate_feature_server_config(cls, values: Any) -> Any:
# Having no feature server is the default.
if "feature_server" not in values:
return values
# Skip if we aren't creating the configuration from a dict
if not isinstance(values["feature_server"], Dict):
return values
defined_type = values["feature_server"].get("type", "local")
values["feature_server"]["type"] = defined_type
# Validate the dict to ensure one of the union types match
try:
feature_server_config_class = get_feature_server_config_from_type(
defined_type
)
feature_server_config_class(**values["feature_server"])
except ValidationError as e:
raise e
return values
@field_validator("project")
@classmethod
def _validate_project_name(cls, v: str, info: ValidationInfo) -> str:
# Deferred import to avoid circular dependency during package initialization.
from feast.repo_operations import is_valid_name
sqlite_compatible = False
online_store = info.data.get("online_store") if info else None
if online_store is None or online_store == {}:
sqlite_compatible = True
elif isinstance(online_store, dict):
sqlite_compatible = online_store.get("type", "sqlite") == "sqlite"
if not is_valid_name(v):
raise ValueError(
f"Project name, {v}, should only have "
f"alphanumerical values, underscores, and hyphens but not start with an underscore or hyphen."
)
if sqlite_compatible and "-" in v:
raise ValueError(
"Project names for SQLite online stores cannot contain hyphens because they are used in table names."
)
return v
@field_validator("flags")
@classmethod
def _validate_flags(cls, v: Optional[dict]) -> Optional[dict]:
if not isinstance(v, dict):
return v
_logger.warning(
"Flags are no longer necessary in Feast. Experimental features will log warnings instead."
)
return v
def write_to_path(self, repo_path: Path):
config_path = repo_path / "feature_store.yaml"
with open(config_path, mode="w") as f:
yaml.dump(
yaml.safe_load(
self.json(
exclude={"repo_path"},
exclude_unset=True,
)
),
f,
sort_keys=False,
)
model_config = ConfigDict(populate_by_name=True)
class FeastConfigError(Exception):
def __init__(self, error_message, config_path):
self._error_message = error_message
self._config_path = config_path
super().__init__(self._error_message)
def __str__(self) -> str:
return f"{self._error_message}\nat {self._config_path}"
def __repr__(self) -> str:
return (
f"FeastConfigError({repr(self._error_message)}, {repr(self._config_path)})"
)
def get_data_source_class_from_type(data_source_type: str):
module_name, config_class_name = data_source_type.rsplit(".", 1)
return import_class(module_name, config_class_name, "DataSource")
def get_registry_config_from_type(registry_type: str):
# We do not support custom registry's right now
if registry_type not in REGISTRY_CLASS_FOR_TYPE:
raise FeastRegistryTypeInvalidError(registry_type)
registry_type = REGISTRY_CLASS_FOR_TYPE[registry_type]
module_name, registry_class_type = registry_type.rsplit(".", 1)
config_class_name = f"{registry_class_type}Config"
return import_class(module_name, config_class_name, config_class_name)
def get_batch_engine_config_from_type(batch_engine_type: str):
if batch_engine_type in BATCH_ENGINE_CLASS_FOR_TYPE:
batch_engine_type = BATCH_ENGINE_CLASS_FOR_TYPE[batch_engine_type]
else:
assert batch_engine_type.endswith("Engine")
module_name, batch_engine_class_type = batch_engine_type.rsplit(".", 1)
config_class_name = f"{batch_engine_class_type}Config"
return import_class(module_name, config_class_name, config_class_name)
def get_online_config_from_type(online_store_type: str):
if online_store_type in ONLINE_STORE_CLASS_FOR_TYPE:
online_store_type = ONLINE_STORE_CLASS_FOR_TYPE[online_store_type]
elif not online_store_type.endswith("OnlineStore"):
raise FeastOnlineStoreInvalidName(online_store_type)
module_name, online_store_class_type = online_store_type.rsplit(".", 1)
config_class_name = f"{online_store_class_type}Config"
return import_class(module_name, config_class_name, config_class_name)
def get_auth_config_from_type(auth_config_type: str):
if auth_config_type in AUTH_CONFIGS_CLASS_FOR_TYPE:
auth_config_type = AUTH_CONFIGS_CLASS_FOR_TYPE[auth_config_type]
elif not auth_config_type.endswith("AuthConfig"):
raise FeastInvalidAuthConfigClass(auth_config_type)
module_name, online_store_class_type = auth_config_type.rsplit(".", 1)
config_class_name = f"{online_store_class_type}"
return import_class(module_name, config_class_name, config_class_name)
def get_offline_store_type(offline_store_type: str):
if offline_store_type in OFFLINE_STORE_CLASS_FOR_TYPE:
return OFFLINE_STORE_CLASS_FOR_TYPE[offline_store_type]
elif not offline_store_type.endswith("OfflineStore"):
raise FeastOfflineStoreInvalidName(offline_store_type)
return offline_store_type
def get_offline_config_from_type(offline_store_type: str):
offline_store_type = get_offline_store_type(offline_store_type)
module_name, offline_store_class_type = offline_store_type.rsplit(".", 1)
config_class_name = f"{offline_store_class_type}Config"
return import_class(module_name, config_class_name, config_class_name)
def get_feature_server_config_from_type(feature_server_type: str):
# We do not support custom feature servers right now.
if feature_server_type not in FEATURE_SERVER_CONFIG_CLASS_FOR_TYPE:
raise FeastFeatureServerTypeInvalidError(feature_server_type)
feature_server_type = FEATURE_SERVER_CONFIG_CLASS_FOR_TYPE[feature_server_type]
module_name, config_class_name = feature_server_type.rsplit(".", 1)
return import_class(module_name, config_class_name, config_class_name)
def load_repo_config(repo_path: Path, fs_yaml_file: Path) -> RepoConfig:
config_path = fs_yaml_file
with open(config_path) as f:
raw_config = yaml.safe_load(os.path.expandvars(f.read()))
try:
c = RepoConfig(**raw_config)
c.repo_path = repo_path
return c
except ValidationError as e:
raise FeastConfigError(e, config_path)