dsgrid API

This section links to commonly-used classes and functions in the dsgrid API.

• Registry
  • Registry Managers
    • RegistryManager
      • RegistryManager.dataset_manager
      • RegistryManager.dimension_mapping_manager
      • RegistryManager.dimension_manager
      • RegistryManager.project_manager
      • RegistryManager.load()
    • ProjectRegistryManager
      • ProjectRegistryManager.get_by_id()
      • ProjectRegistryManager.load_project()
      • ProjectRegistryManager.show()
    • DatasetRegistryManager
      • DatasetRegistryManager.get_by_id()
      • DatasetRegistryManager.show()
    • DimensionRegistryManager
      • DimensionRegistryManager.get_by_id()
      • DimensionRegistryManager.show()
    • DimensionMappingRegistryManager
      • DimensionMappingRegistryManager.get_by_id()
      • DimensionMappingRegistryManager.show()
    • DatabaseConnection
      • DatabaseConnection.database
      • DatabaseConnection.hostname
      • DatabaseConnection.password
      • DatabaseConnection.port
      • DatabaseConnection.username
      • DatabaseConnection.from_url()
      • DatabaseConnection.url
  • Project
    • Project
      • Project.version
      • Project.get_dataset()
    • ProjectConfig
      • ProjectConfig.get_base_dimension()
      • ProjectConfig.get_dimension()
      • ProjectConfig.get_dimension_records()
      • ProjectConfig.list_supplemental_dimensions()
      • ProjectConfig.get_base_to_supplemental_dimension_mappings_by_types()
      • ProjectConfig.get_base_to_supplemental_config()
      • ProjectConfig.get_base_to_supplemental_mapping_records()
      • ProjectConfig.list_dimension_query_names()
      • ProjectConfig.get_base_dimension_to_query_name_mapping()
      • ProjectConfig.get_supplemental_dimension_to_query_name_mapping()
      • ProjectConfig.list_registered_dataset_ids()
      • ProjectConfig.list_unregistered_dataset_ids()
      • ProjectConfig.get_required_dimension_record_ids()
    • ProjectDimensionQueryNamesModel
      • ProjectDimensionQueryNamesModel.geography
      • ProjectDimensionQueryNamesModel.metric
      • ProjectDimensionQueryNamesModel.model_year
      • ProjectDimensionQueryNamesModel.scenario
      • ProjectDimensionQueryNamesModel.sector
      • ProjectDimensionQueryNamesModel.subsector
      • ProjectDimensionQueryNamesModel.time
      • ProjectDimensionQueryNamesModel.weather_year
    • DimensionsByCategoryModel
      • DimensionsByCategoryModel.base
      • DimensionsByCategoryModel.subset
      • DimensionsByCategoryModel.supplemental
  • Dimension
    • DimensionConfig
      • DimensionConfig.get_unique_ids()
      • DimensionConfig.get_records_dataframe()
  • Examples
• Query
  • Data Models
    • ProjectQueryModel
      • ProjectQueryModel.project
      • ProjectQueryModel.result
      • ProjectQueryModel.serialize_cached_content()
    • ProjectQueryParamsModel
      • ProjectQueryParamsModel.dataset
      • ProjectQueryParamsModel.excluded_dataset_ids
      • ProjectQueryParamsModel.include_dsgrid_dataset_components
      • ProjectQueryParamsModel.project_id
      • ProjectQueryParamsModel.spark_conf_per_dataset
      • ProjectQueryParamsModel.version
      • ProjectQueryParamsModel.check_unsupported_fields
      • ProjectQueryParamsModel.get_spark_conf()
    • QueryResultParamsModel
      • QueryResultParamsModel.aggregate_each_dataset
      • QueryResultParamsModel.aggregations
      • QueryResultParamsModel.column_type
      • QueryResultParamsModel.dimension_filters
      • QueryResultParamsModel.output_format
      • QueryResultParamsModel.replace_ids_with_names
      • QueryResultParamsModel.reports
      • QueryResultParamsModel.sort_columns
      • QueryResultParamsModel.table_format
      • QueryResultParamsModel.time_zone
      • QueryResultParamsModel.check_column_type
      • QueryResultParamsModel.check_format
      • QueryResultParamsModel.check_pivot_dimension_type
    • DatasetModel
      • DatasetModel.dataset_id
      • DatasetModel.expression
      • DatasetModel.params
      • DatasetModel.source_datasets
      • DatasetModel.handle_expression
    • StandaloneDatasetModel
      • StandaloneDatasetModel.dataset_id
      • StandaloneDatasetModel.dataset_type
      • StandaloneDatasetModel.get_dataset_id()
    • ProjectionDatasetModel
      • ProjectionDatasetModel.base_year
      • ProjectionDatasetModel.construction_method
      • ProjectionDatasetModel.dataset_id
      • ProjectionDatasetModel.dataset_type
      • ProjectionDatasetModel.growth_rate_dataset_id
      • ProjectionDatasetModel.initial_value_dataset_id
      • ProjectionDatasetModel.get_dataset_id()
    • AggregationModel
      • AggregationModel.aggregation_function
      • AggregationModel.dimensions
      • AggregationModel.check_aggregation_function
      • AggregationModel.check_for_metric
      • AggregationModel.iter_dimensions_to_keep()
      • AggregationModel.list_dropped_dimensions()
      • AggregationModel.serialize_aggregation_function()
    • ColumnModel
      • ColumnModel.alias
      • ColumnModel.dimension_query_name
      • ColumnModel.function
      • ColumnModel.get_column_name()
      • ColumnModel.handle_alias
      • ColumnModel.handle_function
      • ColumnModel.serialize_function()
    • DimensionQueryNamesModel
      • DimensionQueryNamesModel.geography
      • DimensionQueryNamesModel.metric
      • DimensionQueryNamesModel.model_year
      • DimensionQueryNamesModel.scenario
      • DimensionQueryNamesModel.sector
      • DimensionQueryNamesModel.subsector
      • DimensionQueryNamesModel.time
      • DimensionQueryNamesModel.weather_year
      • DimensionQueryNamesModel.fix_columns
    • FilteredDatasetModel
      • FilteredDatasetModel.dataset_id
      • FilteredDatasetModel.filters
    • ReportInputModel
      • ReportInputModel.inputs
      • ReportInputModel.report_type
    • SparkConfByDataset
      • SparkConfByDataset.conf
      • SparkConfByDataset.dataset_id
    • ColumnType
    • DatasetType
    • ReportType
  • Submission
    • ProjectQuerySubmitter
      • ProjectQuerySubmitter.submit()
  • Examples