API 文档
===============


.. _package_element_idx :

元素
----

.. autosummary::
   :toctree: generated/
   
   ~deepfos.element.apvlprocess.ApprovalProcess
   ~deepfos.element.bizmodel.BusinessModel
   ~deepfos.element.datatable.DataTableMySQL
   ~deepfos.element.datatable.DataTableClickHouse
   ~deepfos.element.datatable.DataTableSQLServer
   ~deepfos.element.datatable.DataTableOracle
   ~deepfos.element.datatable.DataTableKingBase
   ~deepfos.element.datatable.DataTableGauss
   ~deepfos.element.datatable.DataTableDaMeng
   ~deepfos.element.datatable.DataTablePostgreSQL
   ~deepfos.element.datatable.DataTableDeepEngine
   ~deepfos.element.datatable.DataTableDeepModel
   ~deepfos.element.datatable.DataTableDeepModelKingBase
   ~deepfos.element.dimension.Dimension
   ~deepfos.element.finmodel.FinancialCube
   ~deepfos.element.rolestrategy.RoleStrategy
   ~deepfos.element.smartlist.SmartList
   ~deepfos.element.variable.Variable
   ~deepfos.element.fact_table.FactTable
   ~deepfos.element.journal_template.JournalTemplate
   ~deepfos.element.accounting.AccountingEngines
   ~deepfos.element.accounting.BillEngines
   ~deepfos.element.accounting.AccountingEventType
   ~deepfos.element.pyscript.PythonScript
   ~deepfos.element.workflow.WorkFlow
   ~deepfos.element.deepmodel.DeepModel
   ~deepfos.element.reconciliation.ReconciliationEngine
   ~deepfos.element.reconciliation.ReconciliationMsEngine
   ~deepfos.element.journal.JournalModel
   ~deepfos.element.deepconnector.DeepConnector
   ~deepfos.element.deep_pipeline.DeepPipeline

.. _package_async_element_idx :

异步元素
------------

.. autosummary::
   :toctree: generated/

   ~deepfos.element.apvlprocess.AsyncApprovalProcess
   ~deepfos.element.bizmodel.AsyncBusinessModel
   ~deepfos.element.datatable.AsyncDataTableMySQL
   ~deepfos.element.datatable.AsyncDataTableClickHouse
   ~deepfos.element.datatable.AsyncDataTableSQLServer
   ~deepfos.element.datatable.AsyncDataTableOracle
   ~deepfos.element.datatable.AsyncDataTableKingBase
   ~deepfos.element.datatable.AsyncDataTableGauss
   ~deepfos.element.datatable.AsyncDataTableDaMeng
   ~deepfos.element.datatable.AsyncDataTablePostgreSQL
   ~deepfos.element.datatable.AsyncDataTableDeepEngine
   ~deepfos.element.datatable.AsyncDataTableDeepModel
   ~deepfos.element.datatable.AsyncDataTableDeepModelKingBase
   ~deepfos.element.dimension.AsyncDimension
   ~deepfos.element.finmodel.AsyncFinancialCube
   ~deepfos.element.rolestrategy.AsyncRoleStrategy
   ~deepfos.element.smartlist.AsyncSmartList
   ~deepfos.element.variable.AsyncVariable
   ~deepfos.element.fact_table.AsyncFactTable
   ~deepfos.element.journal_template.AsyncJournalTemplate
   ~deepfos.element.accounting.AsyncAccountingEngines
   ~deepfos.element.accounting.AsyncBillEngines
   ~deepfos.element.accounting.AsyncAccountingEventType
   ~deepfos.element.workflow.AsyncWorkFlow
   ~deepfos.element.deepmodel.AsyncDeepModel
   ~deepfos.element.reconciliation.AsyncReconciliationEngine
   ~deepfos.element.reconciliation.AsyncReconciliationMsEngine
   ~deepfos.element.journal.AsyncJournalModel
   ~deepfos.element.deepconnector.AsyncDeepConnector
   ~deepfos.element.deep_pipeline.AsyncDeepPipeline

.. _package_core_idx :


高级功能
--------

.. autosummary::
   :toctree: generated/

   ~deepfos.core.SysCube
   ~deepfos.core.SysDimension
   ~deepfos.core.DimMember
   ~deepfos.core.DimExprAnalysor
   ~deepfos.core.MetaTable
   ~deepfos.core.BaseTable
   ~deepfos.core.SQLCondition


.. _package_api_idx :

HTTP接口
-----------

系统接口
++++++++
  
.. autosummary::
   :toctree: generated/
   :template: autosummary/api_class.rst

   ~deepfos.api.system.SystemAPI
   ~deepfos.api.space.SpaceAPI
   ~deepfos.api.app.AppAPI
   ~deepfos.api.platform.PlatformAPI
   ~deepfos.api.account.AccountAPI


组件接口
++++++++

.. tabs::

    .. group-tab:: 1.0

        .. autosummary::
           :template: autosummary/api_class.rst
           :toctree: generated/

           ~deepfos.api.approval_process.ApprovalProcessAPI
           ~deepfos.api.business_model.BusinessModelAPI
           ~deepfos.api.datatable.MySQLAPI
           ~deepfos.api.datatable.ClickHouseAPI
           ~deepfos.api.datatable.SQLServerAPI
           ~deepfos.api.datatable.OracleAPI
           ~deepfos.api.datatable.KingBaseAPI
           ~deepfos.api.datatable.GaussAPI
           ~deepfos.api.datatable.DaMengAPI
           ~deepfos.api.datatable.DeepEngineAPI
           ~deepfos.api.datatable.PostgreSQLAPI
           ~deepfos.api.datatable.DeepModelAPI
           ~deepfos.api.datatable.DeepModelKingBaseAPI
           ~deepfos.api.deepfos_task.TaskAPI
           ~deepfos.api.dimension.DimensionAPI
           ~deepfos.api.financial_model.FinancialModelAPI
           ~deepfos.api.journal_template.JournalTemplateAPI
           ~deepfos.api.memory_financial_model.MemFinancialModelAPI
           ~deepfos.api.reconciliation_engine.ReconcilationAPI
           ~deepfos.api.reconciliation_report.ReconciliationReportAPI
           ~deepfos.api.role_strategy.RoleStrategyAPI
           ~deepfos.api.smartlist.SmartListAPI
           ~deepfos.api.variable.VariableAPI
           ~deepfos.api.accounting_engines.AccountingEnginesAPI
           ~deepfos.api.accounting_engines.BillEnginesAPI
           ~deepfos.api.accounting_engines.AccountingEventTypeAPI
           ~deepfos.api.journal_model.JournalModelAPI
           ~deepfos.api.workflow.WorkFlowAPI
           ~deepfos.api.python.PythonAPI
           ~deepfos.api.deepconnector.DeepConnectorAPI
           ~deepfos.api.deepmodel.DeepModelAPI
           ~deepfos.api.deep_pipeline.DeepPipelineAPI


    .. group-tab:: 1.1

        .. autosummary::
           :template: autosummary/api_class.rst
           :toctree: generated/

           ~deepfos.api.V1_1.business_model.BusinessModelAPI
           ~deepfos.api.V1_1.dimension.DimensionAPI


    .. group-tab:: 1.2

        .. autosummary::
           :template: autosummary/api_class.rst
           :toctree: generated/

           ~deepfos.api.V1_2.dimension.DimensionAPI


数据模型
++++++++

.. tabs::

    .. group-tab:: 1.0

        .. autosummary::
           :toctree: generated/
           :template: autosummary/apimodel_package.rst
           :recursive:

           ~deepfos.api.models

    .. group-tab:: 1.1

        .. autosummary::
           :toctree: generated/
           :template: autosummary/apimodel_package.rst
           :recursive:

           ~deepfos.api.V1_1.models

    .. group-tab:: 1.2

        .. autosummary::
           :toctree: generated/
           :template: autosummary/apimodel_package.rst
           :recursive:

           ~deepfos.api.V1_2.models


.. _package_lib_idx :

工具
----

.. autosummary::
   :template: autosummary/lib_module.rst
   :toctree: generated/

   ~deepfos.lib.decorator
   ~deepfos.lib.stopwatch
   ~deepfos.lib.utils
   ~deepfos.lib.sysutils
   ~deepfos.lib.subtask
   ~deepfos.lib.redis
   ~deepfos.lib.deepchart
   ~deepfos.lib.deepux
   ~deepfos.lib.msg


.. _package_db_idx :

数据库
------

.. autosummary::
   :toctree: generated/
   
   ~deepfos.db.MySQLClient
   ~deepfos.db.AsyncMySQLClient
   ~deepfos.db.ClickHouseClient
   ~deepfos.db.AsyncClickHouseClient
   ~deepfos.db.SQLServerClient
   ~deepfos.db.AsyncSQLServerClient
   ~deepfos.db.OracleClient
   ~deepfos.db.AsyncOracleClient
   ~deepfos.db.KingBaseClient
   ~deepfos.db.AsyncKingBaseClient
   ~deepfos.db.GaussClient
   ~deepfos.db.AsyncGaussClient
   ~deepfos.db.DaMengClient
   ~deepfos.db.AsyncDaMengClient
   ~deepfos.db.PostgreSQLClient
   ~deepfos.db.AsyncPostgreSQLClient
   ~deepfos.db.DeepEngineClient
   ~deepfos.db.AsyncDeepEngineClient
   ~deepfos.db.DeepModelClient
   ~deepfos.db.AsyncDeepModelClient
   ~deepfos.db.DeepModelKingBaseClient
   ~deepfos.db.AsyncDeepModelKingBaseClient

   
.. _package_exceptions_idx :

其他
----

.. autosummary::
   :toctree: generated/

   ~deepfos.exceptions

.. autosummary::
   :template: autosummary/lib_module.rst
   :toctree: generated/

   ~deepfos.translation