# This file is auto-generated by generate_models.py
# This file may be manually edited after generation
# The file has been formatted using isort and black

from typing import Any, ClassVar, Dict, List

from sqlalchemy import Column, PrimaryKeyConstraint, text

from tushare_models.core import Base, Date, DateTime, Float, Integer, String
from tushare_models.core.dialect_config import apply_table_dialect_options


class EtfIndex(Base):
    """ETF基准指数"""

    __tablename__: str = "etf_index"
    __api_id__: ClassVar[int] = 386
    __api_name__: ClassVar[str] = "etf_index"
    __api_title__: ClassVar[str] = "ETF基准指数"
    __api_info_title__: ClassVar[str] = "ETF基准指数"
    __api_path__: ClassVar[List[str]] = ["数据接口", "ETF专题"]
    __api_path_ids__: ClassVar[List[int]] = [1, 11]
    __api_points_required__: ClassVar[int] = 0
    __api_special_permission__: ClassVar[bool] = False
    __has_vip__: ClassVar[bool] = False
    __dependencies__: ClassVar[List[str]] = ["fund_basic"]
    __primary_key__: ClassVar[List[str]] = ["ts_code"]
    __start_date__: ClassVar[str | None] = None
    __end_date__: ClassVar[str | None] = None
    __api_params__: ClassVar[Dict[str, Any]] = {
        "ts_code": {"type": "String", "required": False, "description": "指数代码"},
        "pub_date": {"type": "String", "required": False, "description": "指数发布日期"},
        "base_date": {"type": "String", "required": False, "description": "指数基日"},
        "limit": {"type": "Int64", "required": False, "description": "单次返回数据长度"},
        "offset": {"type": "Int64", "required": False, "description": "请求数据的开始位移量"},
    }

    __mapper_args__ = {"primary_key": __primary_key__}
    __table_args__ = (
        PrimaryKeyConstraint(*__primary_key__),
        {
            "comment": "ETF基准指数",
            # MySQL引擎
            "mysql_engine": "InnoDB",
        },
    )

    ts_code = Column("ts_code", String(16), nullable=False, comment="指数代码")
    indx_name = Column("indx_name", String(), nullable=True, comment="指数全称")
    indx_csname = Column("indx_csname", String(), nullable=True, comment="指数简称")
    pub_party_name = Column("pub_party_name", String(), nullable=True, comment="指数发布机构名称")
    pub_date = Column("pub_date", Date, nullable=True, comment="指数发布日期 ")
    base_date = Column("base_date", Date, nullable=True, comment="指数基日")
    bp = Column("bp", Float, nullable=True, comment="指数基点(点)")
    adj_circle = Column("adj_circle", String(), nullable=True, comment="指数成份证券调整周期")

apply_table_dialect_options(EtfIndex)
