Skip to main content

sc_crawler.tables

Table definitions for vendors, regions, zones, and other cloud resources.

Classes:

  • Country – Country and continent mapping.
  • ComplianceFramework – List of Compliance Frameworks, such as HIPAA or SOC 2 Type 1.
  • Vendor – Compute resource vendors, such as cloud and server providers.
  • VendorComplianceLink – List of known Compliance Frameworks paired with vendors.
  • Region – Regions of Vendors.
  • Zone – Availability zones of Regions.
  • Storage – Flexible storage options that can be attached to a Server.
  • Server – Server types.
  • ServerPrice – Server type prices per Region and Allocation method.
  • ServerDescription – Variable length, plain English descriptions of Server hardware specs, performance, cost-efficiency, and workflow fit.
  • StoragePrice – Flexible Storage prices in each Region.
  • Database – Managed database SKUs.
  • DatabasePrice – Managed database SKU prices per Region.
  • DatabaseStorage – Managed database storage products.
  • DatabaseStoragePrice – Managed database storage prices in each Region.
  • TrafficPrice – Extra Traffic prices in each Region.
  • Ipv4Price – Price of an IPv4 address in each Region.
  • Benchmark – Benchmark scenario definitions.
  • BenchmarkScore – Results of running Benchmark scenarios on Servers or managed Databases.
  • Metadata – Key/value metadata table for database release information.

Attributes:

  • tables (List[SQLModel]) – List of all SQLModel (table) models.

class Country​

Bases: CountryBase

Country and continent mapping.

Attributes:

  • country_id (str) – Country code by ISO 3166 alpha-2.
  • continent (str) – Continent name.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class ComplianceFramework​

Bases: ComplianceFrameworkBase

List of Compliance Frameworks, such as HIPAA or SOC 2 Type 1.

Attributes:

  • compliance_framework_id (str) – Unique identifier.
  • name (str) – Human-friendly name.
  • abbreviation (Optional[str]) – Short abbreviation of the Framework name.
  • description (Optional[str]) – Description of the framework in a few paragraphs, outlining key features and characteristics for reference.
  • logo (Optional[str]) – Publicly accessible URL to the image of the Framework's logo.
  • homepage (Optional[str]) – Public homepage with more information on the Framework.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class Vendor​

Bases: VendorBase

Compute resource vendors, such as cloud and server providers.

Examples:

>>> from sc_crawler.tables import Vendor
>>> from sc_crawler.lookup import countries
>>> aws = Vendor(vendor_id='aws', name='Amazon Web Services', homepage='https://aws.amazon.com', country=countries["US"], founding_year=2002)
>>> aws
Vendor(vendor_id='aws'...
>>> from sc_crawler import vendors
>>> vendors.aws
Vendor(vendor_id='aws'...

Attributes:

  • vendor_id (str) – Unique identifier.
  • name (str) – Human-friendly name.
  • logo (Optional[str]) – Publicly accessible URL to the image of the Vendor's logo.
  • homepage (Optional[str]) – Public homepage of the Vendor.
  • country_id (str) – Reference to the Country, where the Vendor's main headquarter is located.
  • state (Optional[str]) – Optional state/administrative area of the Vendor's location within the Country.
  • city (Optional[str]) – Optional city name of the Vendor's main location.
  • address_line (Optional[str]) – Optional address line of the Vendor's main location.
  • zip_code (Optional[str]) – Optional ZIP code of the Vendor's main location.
  • founding_year (int) – 4-digit year when the public cloud service of the Vendor was launched.
  • status_page (Optional[str]) – Public status page of the Vendor.
  • stopped_server_charged (Optional[bool]) – If the Vendor charges for stopped servers. In case it depends on the instance type or different versions of stopped states, this field reports the worst case.
  • billing_increment_seconds (Optional[int]) – The smallest increment of time for which the Vendor bills for.
  • minimum_billing_seconds (Optional[int]) – The minimum amount of time for which the Vendor bills for. In case it depends on the instance type or other context, this field reports the worst case.
  • billing_comment (Optional[str]) – Comment on the Vendor's billing.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

Functions:

attr 
Vendor.session
​

session

The Session to use for merging dependent objects into the database.

attr 
Vendor.progress_tracker
​

progress_tracker

The sc_crawler.logger.VendorProgressTracker to use for updating progress bars.

attr 
Vendor.tasks
​

tasks

Reexport progress_tracker.tasks for easier access.

meth 
Vendor.set_table_rows_inactive
​

set_table_rows_inactive(model, *args)

Set this vendor's records to INACTIVE in a table.

Positional arguments can be used to pass further filters (besides the default model.vendor_id filter) referencing the model object with SQLModel syntax.

Examples:

>>> aws.set_table_rows_inactive(ServerPrice, ServerPrice.price < 10)

meth 
Vendor.set_table_rows_active
​

set_table_rows_active(model, *args)

Set this vendor's records to ACTIVE in a table.

Positional arguments can be used to pass further filters (besides the default model.vendor_id filter) referencing the model object with SQLModel syntax.

Examples:

>>> aws.set_table_rows_active(ServerPrice, ServerPrice.price < 10)

meth 
Vendor.inventory_compliance_frameworks
​

inventory_compliance_frameworks()

Get the vendor's all compliance frameworks.

meth 
Vendor.inventory_regions
​

inventory_regions()

Get the vendor's all regions.

meth 
Vendor.inventory_zones
​

inventory_zones()

Get all the zones in the vendor's regions.

meth 
Vendor.inventory_servers
​

inventory_servers()

Get the vendor's all server types.

meth 
Vendor.inventory_server_prices
​

inventory_server_prices()

Get the current standard/ondemand/reserved prices of all server types.

meth 
Vendor.inventory_server_prices_spot
​

inventory_server_prices_spot()

Get the current spot prices of all server types.

meth 
Vendor.inventory_storages
​

inventory_storages()

Get the vendor's all storage types.

meth 
Vendor.inventory_storage_prices
​

inventory_storage_prices()

Get the current prices of all storage types.

meth 
Vendor.inventory_traffic_prices
​

inventory_traffic_prices()

Get the current prices of all traffic types.

meth 
Vendor.inventory_ipv4_prices
​

inventory_ipv4_prices()

Get the current prices of all IPv4 types.

meth 
Vendor.inventory_databases
​

inventory_databases()

Get the vendor's all managed database types.

meth 
Vendor.inventory_database_prices
​

inventory_database_prices()

Get the current prices of all managed database types.

meth 
Vendor.inventory_database_storages
​

inventory_database_storages()

Get the vendor's all managed database storage products.

meth 
Vendor.inventory_database_storage_prices
​

inventory_database_storage_prices()

Get the current prices of all managed database storage products.

Bases: VendorComplianceLinkBase

List of known Compliance Frameworks paired with vendors.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • compliance_framework_id (str) – Reference to the Compliance Framework.
  • comment (Optional[str]) – Optional references, such as dates, URLs, and additional information/evidence.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class Region​

Bases: RegionBase

Regions of Vendors.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • region_id (str) – Unique identifier, as called at the Vendor.
  • name (str) – Human-friendly name.
  • api_reference (str) – How this resource is referenced in the vendor API calls. This is usually either the id or name of the resource, depending on the vendor and actual API endpoint.
  • display_name (str) – Human-friendly reference (usually the id or name) of the resource.
  • aliases (List[str]) – List of other commonly used names for the same Region.
  • country_id (str) – Reference to the Country, where the Region is located.
  • state (Optional[str]) – Optional state/administrative area of the Region's location within the Country.
  • city (Optional[str]) – Optional city name of the Region's location.
  • address_line (Optional[str]) – Optional address line of the Region's location.
  • zip_code (Optional[str]) – Optional ZIP code of the Region's location.
  • lon (Optional[float]) – Longitude coordinate of the Region's known or approximate location.
  • lat (Optional[float]) – Latitude coordinate of the Region's known or approximate location.
  • founding_year (Optional[int]) – 4-digit year when the Region was founded.
  • green_energy (Optional[bool]) – If the Region is 100% powered by renewable energy.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class Zone​

Bases: ZoneBase

Availability zones of Regions.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • region_id (str) – Reference to the Region.
  • zone_id (str) – Unique identifier, as called at the Vendor.
  • name (str) – Human-friendly name.
  • api_reference (str) – How this resource is referenced in the vendor API calls. This is usually either the id or name of the resource, depending on the vendor and actual API endpoint.
  • display_name (str) – Human-friendly reference (usually the id or name) of the resource.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class Storage​

Bases: StorageBase

Flexible storage options that can be attached to a Server.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • storage_id (str) – Unique identifier, as called at the Vendor.
  • name (str) – Human-friendly name.
  • description (Optional[str]) – Short description.
  • storage_type (StorageType) – High-level category of the storage, e.g. HDD or SDD.
  • max_iops (Optional[int]) – Maximum Input/Output Operations Per Second.
  • max_throughput (Optional[int]) – Maximum Throughput (MB/s).
  • min_size (Optional[int]) – Minimum required size (GB).
  • max_size (Optional[int]) – Maximum possible size (GB).
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class Server​

Bases: ServerBase

Server types.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • server_id (str) – Unique identifier, as called at the Vendor.
  • name (str) – Human-friendly name.
  • api_reference (str) – How this resource is referenced in the vendor API calls. This is usually either the id or name of the resource, depending on the vendor and actual API endpoint.
  • display_name (str) – Human-friendly reference (usually the id or name) of the resource.
  • description (str) – Short description.
  • family (Optional[str]) – Server family, e.g. General-purpose machine (GCP), or M5g (AWS).
  • vcpus (int) – Default number of virtual CPUs (vCPU) of the server.
  • hypervisor (Optional[str]) – Hypervisor of the virtual server, e.g. Xen, KVM, Nitro or Dedicated.
  • cpu_allocation (CpuAllocation) – Allocation of CPU(s) to the server, e.g. shared, burstable or dedicated.
  • cpu_cores (Optional[int]) – Default number of CPU cores of the server. Equals to vCPUs when HyperThreading is disabled.
  • cpu_speed (Optional[float]) – Vendor-reported maximum CPU clock speed (GHz).
  • cpu_architecture (CpuArchitecture) – CPU architecture (arm64, arm64_mac, i386, or x86_64).
  • cpu_manufacturer (Optional[str]) – The manufacturer of the primary processor, e.g. Intel or AMD.
  • cpu_family (Optional[str]) – The product line/family of the primary processor, e.g. Xeon, Core i7, Ryzen 9.
  • cpu_model (Optional[str]) – The model number of the primary processor, e.g. 9750H.
  • cpu_l1d_cache (Optional[int]) – L1 data cache size (KiB).
  • cpu_l1d_cache_total (Optional[int]) – Total L1 data cache size (KiB) across all cores.
  • cpu_l1i_cache (Optional[int]) – L1 instruction cache size (KiB).
  • cpu_l1i_cache_total (Optional[int]) – Total L1 instruction cache size (KiB) across all cores.
  • cpu_l2_cache (Optional[int]) – L2 cache size (KiB).
  • cpu_l2_cache_total (Optional[int]) – Total L2 cache size (KiB) across all cores.
  • cpu_l3_cache (Optional[int]) – L3 cache size (KiB).
  • cpu_l3_cache_total (Optional[int]) – Total L3 cache size (KiB) across all cores.
  • cpu_flags (List[str]) – CPU features/flags.
  • cpus (List[Cpu]) – JSON array of known CPU details, e.g. the manufacturer, family, model; L1/L2/L3 cache size; microcode version; feature flags; bugs etc.
  • ecpus (Optional[float]) – The effective "real-world" core count, calculated by dividing the maximum multi-core SCore by the single-core SCore.
  • scalability (Optional[float]) – Measures how efficiently the server scales from a single core performance to using multiple cores. A score of 100% means perfect linear scaling with zero performance loss.
  • hw_virt (Optional[bool]) – If hardware virtualization (e.g. KVM) is supported.
  • memory_amount (int) – RAM amount (MiB) reported by the vendor.
  • memory_amount_actual (Optional[int]) – Actual RAM amount (MiB) measured on the instance via lstopo or other tool. This amount might not match the vendor-reported memory due to the BIOS or the hypervisor reserving a small percentage.
  • memory_generation (Optional[DdrGeneration]) – Generation of the DDR SDRAM, e.g. DDR4 or DDR5.
  • memory_speed (Optional[int]) – DDR SDRAM clock rate (Mhz).
  • memory_ecc (Optional[bool]) – If the DDR SDRAM uses error correction code to detect and correct n-bit data corruption.
  • gpu_count (float) – Number of GPU accelerator(s).
  • gpu_memory_min (Optional[int]) – Memory (MiB) allocated to the lowest-end GPU accelerator.
  • gpu_memory_total (Optional[int]) – Overall memory (MiB) allocated to all the GPU accelerator(s).
  • gpu_manufacturer (Optional[str]) – The manufacturer of the primary GPU accelerator, e.g. Nvidia or AMD.
  • gpu_family (Optional[str]) – The product family of the primary GPU accelerator, e.g. Turing.
  • gpu_model (Optional[str]) – The model number of the primary GPU accelerator, e.g. Tesla T4.
  • gpus (List[Gpu]) – JSON array of GPU accelerator details, including the manufacturer, name, and memory (MiB) of each GPU.
  • storage_size (int) – Overall size (GB) of the disk(s).
  • storage_type (Optional[StorageType]) – Primary disk type, e.g. HDD, SSD, or NVMe SSD.
  • storages (List[Disk]) – JSON array of disks attached to the server, including the size (GB) and type of each disk.
  • network_speed_baseline (Optional[float]) – The baseline network performance (Gbps) of the network card.
  • network_speed_max (Optional[float]) – The maximum network performance (Gbps) of the network card.
  • network_storage_speed_baseline (Optional[float]) – The baseline bandwidth performance of network-attached storage (Gbps).
  • network_storage_speed_max (Optional[float]) – The maximum bandwidth performance of network-attached storage (Gbps).
  • inbound_traffic (float) – Amount of complimentary inbound traffic (GB) per month.
  • outbound_traffic (float) – Amount of complimentary outbound traffic (GB) per month.
  • ipv4 (int) – Number of complimentary IPv4 address(es).
  • average_time_to_start (Optional[float]) – Average time to start the server (seconds).
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

Functions:

meth 
Server.check_inspector_task_block_reasons
​

check_inspector_task_block_reasons(tasks)

Check if the Server should run inspector task(s) and return block reasons.

class ServerPrice​

Bases: ServerPriceBase

Server type prices per Region and Allocation method.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • region_id (str) – Reference to the Region.
  • zone_id (str) – Reference to the Zone.
  • server_id (str) – Reference to the Server.
  • operating_system (str) – Operating System.
  • allocation (Allocation) – Allocation method, e.g. on-demand or spot.
  • unit (PriceUnit) – Billing unit of the pricing model.
  • price (float) – Actual price of a billing unit.
  • price_upfront (float) – Price to be paid when setting up the resource.
  • price_tiered (List[PriceTier]) – List of pricing tiers with min/max thresholds and actual prices.
  • currency (str) – Currency of the prices.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class ServerDescription​

Bases: ServerDescriptionBase

Variable length, plain English descriptions of Server hardware specs, performance, cost-efficiency, and workflow fit.

Attributes:

  • page (List[str]) – Detailed server description with up to 500 words total across multiple paragraphs on hardware specs, benchmark-relative performance, qualitative cost efficiency, tradeoffs, and workload fit.
  • description (str) – Dense and technical server description using around 150 words in a single paragraph.
  • og_description (str) – 200 character server description explicitly including vendor and server name.
  • meta_description (str) – 150 character server description explicitly including vendor and server name.
  • tagline (str) – 20-word tagline on server positioning and key differentiators without the vendor or server name.
  • bullet_points (List[str]) – 4-6 concise bullet points highlighting key features and best-fit workloads.
  • categories (List[Category]) – One or more workload categories best fitting the server.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.
  • vendor_id (str) – Reference to the Vendor.
  • server_id (str) – Unique identifier, as called at the Vendor.

class StoragePrice​

Bases: StoragePriceBase

Flexible Storage prices in each Region.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • region_id (str) – Reference to the Region.
  • storage_id (str) – Reference to the Storage.
  • unit (PriceUnit) – Billing unit of the pricing model.
  • price (float) – Actual price of a billing unit.
  • price_upfront (float) – Price to be paid when setting up the resource.
  • price_tiered (List[PriceTier]) – List of pricing tiers with min/max thresholds and actual prices.
  • currency (str) – Currency of the prices.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class Database​

Bases: DatabaseBase

Managed database SKUs.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • database_id (str) – Unique identifier, as called at the Vendor.
  • name (str) – Human-friendly name.
  • api_reference (str) – How this resource is referenced in the vendor API calls. This is usually either the id or name of the resource, depending on the vendor and actual API endpoint.
  • api_reference_object (Optional[dict]) – How this resource is referenced in the vendor API calls, including the parameter name(s).
  • display_name (str) – Human-friendly reference (usually the id or name) of the resource.
  • description (Optional[str]) – Short description.
  • family (Optional[str]) – Hardware family or class classification.
  • server_id (Optional[str]) – Reference to the underlying cloud server's identifier.
  • vcpus (Optional[int]) – Number of virtual CPU cores allocated to the database server instance.
  • memory_amount (Optional[int]) – Amount of RAM (MiB) provisioned for the instance.
  • engine (Optional[DatabaseEngine]) – Managed database engine running on the instance.
  • wire_protocol (Optional[DatabaseWireProtocol]) – Network protocol used for client connections.
  • engine_versions (List[str]) – Major database engine versions supported.
  • auto_upgrade_versions (Optional[bool]) – Auto-upgrade between minor database engine versions.
  • ha (List[DatabaseHaLevel]) – Ordered HA levels supported, highest tier first.
  • ha_strategy (List[DatabaseHaStrategy]) – Ordered HA strategies supported, highest tier first.
  • max_read_replicas (Optional[int]) – Maximum number of read-only replica nodes supported to scale read workloads.
  • custom_config (Optional[bool]) – Whether database engine parameters/flags can be customized.
  • custom_extensions (Optional[bool]) – Support for custom database engine extensions/plugins.
  • storage_size (Optional[int]) – Bundled storage capacity included in the database (GB).
  • storage_extra_min (Optional[int]) – Minimum custom storage size (in GB) that can be attached to the instance.
  • storage_extra_max (Optional[int]) – Maximum storage limit (in GB) supported by the instance or storage tier.
  • storage_extra_autosize (Optional[bool]) – Whether storage capacity can automatically expand as disk usage grows.
  • disk_encryption (Optional[bool]) – Indicates whether underlying storage drives are encrypted at rest.
  • scheduled_backups (Optional[bool]) – Support for automated snapshot schedules and backup retention management.
  • continuous_backups (Optional[int]) – Maximum point-in-time recovery (PITR) log retention window expressed in days (0 if unsupported).
  • connection_pool (Optional[bool]) – Managed connection proxy support.
  • system_monitoring (Optional[bool]) – Availability of host-level CPU, RAM, and disk metrics dashboards.
  • database_monitoring (Optional[bool]) – Database engine performance insights (slow queries, locks, execution plans).
  • autotuning_advice (Optional[bool]) – Analyzes workload and generates actionable performance tuning advice.
  • autotuning_apply (Optional[bool]) – System automatically executes performance fixes (e.g., index creation, parameter tuning) without operator intervention.
  • sla (Optional[float]) – Service level agreement as a percentage, e.g. 99.95.
  • security_features (List[DatabaseSecurityFeature]) – Security capabilities supported by DBaaS providers.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

Functions:

meth 
Database.check_inspector_task_block_reasons
​

check_inspector_task_block_reasons(tasks)

Check if the Database should run inspector task(s) and return block reasons.

class DatabasePrice​

Bases: DatabasePriceBase

Managed database SKU prices per Region.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • region_id (str) – Reference to the Region.
  • database_id (str) – Reference to the Database.
  • allocation (Allocation) – Allocation method, e.g. on-demand or spot.
  • ha (DatabaseHaLevel) – HA level this price applies to.
  • ha_strategy (DatabaseHaStrategy) – HA strategy this price applies to.
  • unit (PriceUnit) – Billing unit of the pricing model.
  • price (float) – Actual price of a billing unit.
  • price_upfront (float) – Price to be paid when setting up the resource.
  • price_tiered (List[PriceTier]) – List of pricing tiers with min/max thresholds and actual prices.
  • currency (str) – Currency of the prices.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class DatabaseStorage​

Bases: DatabaseStorageBase

Managed database storage products.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • database_storage_id (str) – Unique identifier, as called at the Vendor.
  • name (str) – Human-friendly name.
  • description (Optional[str]) – Short description.
  • scope (DatabaseStorageScope) – Scope of the storage product, e.g. data or backup.
  • redundancy (Optional[str]) – Redundancy model, e.g. LRS or GRS.
  • min_size (Optional[int]) – Minimum required size (GB).
  • max_size (Optional[int]) – Maximum possible size (GB).
  • max_iops (Optional[int]) – Maximum Input/Output Operations Per Second.
  • max_throughput (Optional[int]) – Maximum Throughput (MB/s).
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class DatabaseStoragePrice​

Bases: DatabaseStoragePriceBase

Managed database storage prices in each Region.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • region_id (str) – Reference to the Region.
  • database_storage_id (str) – Reference to the DatabaseStorage.
  • unit (PriceUnit) – Billing unit of the pricing model.
  • price (float) – Actual price of a billing unit.
  • price_upfront (float) – Price to be paid when setting up the resource.
  • price_tiered (List[PriceTier]) – List of pricing tiers with min/max thresholds and actual prices.
  • currency (str) – Currency of the prices.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class TrafficPrice​

Bases: TrafficPriceBase

Extra Traffic prices in each Region.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • region_id (str) – Reference to the Region.
  • direction (TrafficDirection) – Direction of the traffic: inbound or outbound.
  • unit (PriceUnit) – Billing unit of the pricing model.
  • price (float) – Actual price of a billing unit.
  • price_upfront (float) – Price to be paid when setting up the resource.
  • price_tiered (List[PriceTier]) – List of pricing tiers with min/max thresholds and actual prices.
  • currency (str) – Currency of the prices.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class Ipv4Price​

Bases: Ipv4PriceBase

Price of an IPv4 address in each Region.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • region_id (str) – Reference to the Region.
  • unit (PriceUnit) – Billing unit of the pricing model.
  • price (float) – Actual price of a billing unit.
  • price_upfront (float) – Price to be paid when setting up the resource.
  • price_tiered (List[PriceTier]) – List of pricing tiers with min/max thresholds and actual prices.
  • currency (str) – Currency of the prices.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class Benchmark​

Bases: BenchmarkBase

Benchmark scenario definitions.

Attributes:

  • benchmark_id (str) – Unique identifier of a specific Benchmark.
  • category (Optional[str]) – Category of the resource.
  • source (Union[MeasuredSource, ExtrapolatedSource, CompoundSource]) – How the benchmark score is produced. A discriminated object keyed by 'kind': 'measured' (directly observed), 'extrapolated' (derived from this server's own measurements; carries 'derived_from' + 'note'), or 'compound' (aggregated across component benchmarks; carries 'aggregation', 'normalization', and the 'components' recipe).
  • name (str) – Human-friendly name.
  • description (Optional[str]) – Short description.
  • note (Optional[str]) – Optional caveat/comment on how to interpret the metric, surfaced as a warning/info badge (e.g. limited scaling on high vCPU counts, or independence from vCPU count). Null when there is nothing to flag.
  • framework (str) – The name of the benchmark framework/software/tool used.
  • config_fields (dict) – A dictionary of descriptions on the framework-specific config options, e.g. {"bandwidth": "Memory amount to use for compression in MB."}.
  • measurement (Optional[str]) – The name of measurement recorded in the benchmark.
  • unit (Optional[str]) – Optional unit of measurement for the benchmark score.
  • higher_is_better (bool) – If higher benchmark score means better performance, or vica versa.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

class BenchmarkScore​

Bases: BenchmarkScoreBase

Results of running Benchmark scenarios on Servers or managed Databases.

Attributes:

  • vendor_id (str) – Reference to the Vendor.
  • benchmark_id (str) – Reference to the Benchmark.
  • resource_type (ResourceType) – Kind of resource the score refers to.
  • resource_id (str) – Reference to the resource (see resource_type).
  • config (HashableDict|dict) – Dictionary of config parameters of the specific benchmark, e.g. {"bandwidth": 4096}
  • framework_version (Optional[str]) – The version of the benchmark tool used.
  • environment (Optional[dict]) – Extensible environment details (e.g. kernel_version, database_engine_version).
  • score (float) – The resulting score of the benchmark.
  • score_breakdown (Optional[WorkloadScoreBreakdown]) – Structured derivation of composite scores (e.g. workload profiles): per-component raw values, references, normalized values, weights, and coverage. Null for simple benchmark scores.
  • note (Optional[str]) – Optional note, comment or context on the benchmark score.
  • status (Status) – Status of the resource (active or inactive).
  • observed_at (datetime) – Timestamp of the last observation.

attr tables​

tables: List[SQLModel] = [o for o in globals().values() if is_table(o)]

List of all SQLModel (table) models.

class Metadata​

Bases: SQLModel

Key/value metadata table for database release information.