python-bigquery の API リファレンス
python-bigquery (googleapis/python-bigquery) の公開 API 204 件 —— クラス 98、関数 2、メソッド 104。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: googleapis/python-bigquery
| 種別 | 件数 |
|---|---|
| クラス | 98 |
| 関数 | 2 |
| メソッド | 104 |
API 一覧
class
google.cloud.bigquery._http.ConnectionA connection to Google BigQuery via the JSON REST API.
class
google.cloud.bigquery._job_helpers.QueryFinishedEventQuery finished successfully.
class
google.cloud.bigquery._job_helpers.QuerySentEventQuery sent to BigQuery.
func
google.cloud.bigquery._job_helpers.make_job_id(job_id:Optional[str]=None, prefix:Optional[str]=None) -> strConstruct an ID for a new job.
class
google.cloud.bigquery._versions_helpers.PandasVersionsVersion comparisons for pandas package.
method
google.cloud.bigquery._versions_helpers.PandasVersions.installed_version() -> packaging.version.VersionReturn the parsed version of pandas
class
google.cloud.bigquery._versions_helpers.PyarrowVersionsVersion comparisons for pyarrow package.
class
google.cloud.bigquery.client.ClientClient to bundle configuration needed for API requests.
method
google.cloud.bigquery.client.Client.create_job(job_config:dict, retry:retries.Retry=DEFAULT_RETRY, timeout:TimeoutType=DEFAULT_TIMEOUT) -> Union[job.LoadJob, job.CopyJob, job.ExtractJob, job.QueryJob]Create a new job.
method
google.cloud.bigquery.client.Client.dataset(dataset_id:str, project:Optional[str]=None) -> DatasetReferenceDeprecated: Construct a reference to a dataset.
method
google.cloud.bigquery.client.Client.default_load_job_config()Default ``LoadJobConfig``.
method
google.cloud.bigquery.client.Client.default_query_job_config() -> Optional[QueryJobConfig]Default ``QueryJobConfig`` or ``None``.
method
google.cloud.bigquery.client.Client.delete_dataset(dataset:Union[Dataset, DatasetReference, DatasetListItem, str], delete_contents:bool=False, retry:retries.Retry=DEFAULT_RETRY, timeout:TimeoutType=DEFAULT_TIMEOUT, not_found_ok:bool=False) -> NoneDelete a dataset.
method
google.cloud.bigquery.client.Client.delete_routine(routine:Union[Routine, RoutineReference, str], retry:retries.Retry=DEFAULT_RETRY, timeout:TimeoutType=DEFAULT_TIMEOUT, not_found_ok:bool=False) -> None[Beta] Delete a routine.
method
google.cloud.bigquery.client.Client.update_model(model:Model, fields:Sequence[str], retry:retries.Retry=DEFAULT_RETRY, timeout:TimeoutType=DEFAULT_TIMEOUT) -> Model[Beta] Change some fields of a model.
method
google.cloud.bigquery.client.Client.update_table(table:Table, fields:Sequence[str], autodetect_schema:bool=False, retry:retries.Retry=DEFAULT_RETRY, timeout:TimeoutType=DEFAULT_TIMEOUT) -> TableChange some fields of a table.
class
google.cloud.bigquery.client.ProjectWrapper for resource describing a BigQuery project.
class
google.cloud.bigquery.dataset.AccessEntryRepresents grant of an access role to an entity.
method
google.cloud.bigquery.dataset.AccessEntry.domain() -> Optional[str]A domain to grant access to.
method
google.cloud.bigquery.dataset.AccessEntry.entity_id() -> Optional[Union[Dict[str, Any], str]]The entity_id of the entry.
method
google.cloud.bigquery.dataset.AccessEntry.entity_type() -> Optional[str]The entity_type of the entry.
method
google.cloud.bigquery.dataset.AccessEntry.role() -> Optional[str]The role of the entry.
method
google.cloud.bigquery.dataset.AccessEntry.special_group() -> Optional[str]A special group to grant access to.
method
google.cloud.bigquery.dataset.AccessEntry.user_by_email() -> Optional[str]An email address of a user to grant access to.
method
google.cloud.bigquery.dataset.Condition.expression() -> strstr: The expression string for the condition.
method
google.cloud.bigquery.dataset.Condition.title() -> Optional[str]Optional[str]: The title for the condition.
class
google.cloud.bigquery.dataset.DatasetDatasets are containers for tables.
method
google.cloud.bigquery.dataset.Dataset.dataset_id()str: Dataset ID.
method
google.cloud.bigquery.dataset.Dataset.etag()Union[str, None]: Output only.
method
google.cloud.bigquery.dataset.Dataset.from_string(full_dataset_id:str) -> 'Dataset'Construct a dataset from fully-qualified dataset ID.
method
google.cloud.bigquery.dataset.Dataset.full_dataset_id()Union[str, None]: Output only.
method
google.cloud.bigquery.dataset.Dataset.self_link()Union[str, None]: Output only.
class
google.cloud.bigquery.dataset.DatasetListItemA read-only dataset resource from a list operation.
method
google.cloud.bigquery.dataset.DatasetListItem.dataset_id()str: Dataset ID.
class
google.cloud.bigquery.dataset.DatasetReferenceDatasetReferences are pointers to datasets.
method
google.cloud.bigquery.dataset.DatasetReference.dataset_id()str: Dataset ID.
class
google.cloud.bigquery.dbapi.connection.ConnectionDB-API Connection to Google BigQuery.
method
google.cloud.bigquery.dbapi.connection.Connection.cursor()Return a new cursor object.
class
google.cloud.bigquery.dbapi.cursor.CursorDB-API Cursor to Google BigQuery.
class
google.cloud.bigquery.dbapi.exceptions.DatabaseErrorDB-API error related to the database.
class
google.cloud.bigquery.dbapi.exceptions.ErrorException representing all non-warning DB-API errors.
class
google.cloud.bigquery.dbapi.exceptions.InterfaceErrorDB-API error related to the database interface.
class
google.cloud.bigquery.dbapi.exceptions.OperationalErrorDB-API error related to the database operation.
class
google.cloud.bigquery.dbapi.exceptions.ProgrammingErrorDB-API exception raised for programming errors.
class
google.cloud.bigquery.dbapi.exceptions.WarningException raised for important DB-API warnings.
func
google.cloud.bigquery.dbapi.types.Binary(data)Contruct a DB-API binary value.
class
google.cloud.bigquery.enums.CompressionThe compression type to use for exported files.
class
google.cloud.bigquery.enums.DestinationFormatThe exported file format.
class
google.cloud.bigquery.enums.EncodingThe character encoding of the data.
class
google.cloud.bigquery.enums.EntityTypesEnum of allowed entity type names in AccessEntry
class
google.cloud.bigquery.enums.JobCreationModeDocumented values for Job Creation Mode.
class
google.cloud.bigquery.enums.QueryApiMethodAPI method used to start the query.
class
google.cloud.bigquery.enums.QueryPrioritySpecifies a priority for the query.
class
google.cloud.bigquery.enums.SourceFormatThe format of the data files.
class
google.cloud.bigquery.enums.SqlTypeNamesEnum of allowed SQL type names in schema.SchemaField.
class
google.cloud.bigquery.external_config.BigtableColumnOptions for a Bigtable column.
method
google.cloud.bigquery.external_config.BigtableColumn.to_api_repr() -> dictBuild an API representation of this object.
class
google.cloud.bigquery.external_config.BigtableColumnFamilyOptions for a Bigtable column family.
method
google.cloud.bigquery.external_config.BigtableColumnFamily.to_api_repr() -> dictBuild an API representation of this object.
class
google.cloud.bigquery.external_config.ExternalCatalogTableOptionsMetadata about open source compatible table.
method
google.cloud.bigquery.external_config.ExternalCatalogTableOptions.connection_id() -> Optional[str]Optional.
method
google.cloud.bigquery.external_config.ExternalCatalogTableOptions.parameters() -> Union[Dict[str, Any], None]Optional.
method
google.cloud.bigquery.external_config.ExternalCatalogTableOptions.storage_descriptor() -> AnyOptional.
class
google.cloud.bigquery.external_config.ExternalConfigDescription of an external data source.
method
google.cloud.bigquery.external_config.ExternalConfig.options() -> Optional[OptionsType]Source-specific options.
method
google.cloud.bigquery.external_config.ExternalConfig.to_api_repr() -> dictBuild an API representation of this object.
class
google.cloud.bigquery.external_config.ExternalSourceFormatThe format for external data files.
class
google.cloud.bigquery.external_config.HivePartitioningOptionsOptions that configure hive partitioning.
class
google.cloud.bigquery.format_options.AvroOptionsOptions if source format is set to AVRO.
method
google.cloud.bigquery.format_options.AvroOptions.to_api_repr() -> dictBuild an API representation of this object.
class
google.cloud.bigquery.job.base.ScriptStatisticsStatistics for a child job of a script.
method
google.cloud.bigquery.job.base.ScriptStatistics.evaluation_kind() -> Optional[str]str: Indicates the type of child job.
method
google.cloud.bigquery.job.base.SessionInfo.session_id() -> Optional[str]The ID of the session.
class
google.cloud.bigquery.job.base.TransactionInfo[Alpha] Information of a multi-statement transaction.
class
google.cloud.bigquery.job.base.UnknownJobA job whose type cannot be determined.
method
google.cloud.bigquery.job.base.UnknownJob.from_api_repr(resource:dict, client) -> 'UnknownJob'Construct an UnknownJob from the JSON representation.
class
google.cloud.bigquery.job.copy_.CopyJobConfigConfiguration options for copy jobs.
method
google.cloud.bigquery.job.copy_.CopyJobConfig.operation_type() -> strThe operation to perform with this copy job.
class
google.cloud.bigquery.job.extract.ExtractJobConfigConfiguration options for extract jobs.
class
google.cloud.bigquery.job.load.ColumnNameCharacterMapIndicates the character map used for column names.
class
google.cloud.bigquery.job.load.LoadJobAsynchronous job for loading data into a table.
method
google.cloud.bigquery.job.load.LoadJob.configuration() -> LoadJobConfigThe configuration for this load job.
method
google.cloud.bigquery.job.load.LoadJob.from_api_repr(resource:dict, client) -> 'LoadJob'Factory: construct a job given its API representation ..
method
google.cloud.bigquery.job.load.LoadJob.input_files()Count of source files.
class
google.cloud.bigquery.job.load.LoadJobConfigConfiguration options for load jobs.
method
google.cloud.bigquery.job.load.LoadJobConfig.connection_properties() -> List[ConnectionProperty]Connection properties.
class
google.cloud.bigquery.job.query.DmlStatsDetailed statistics for DML statements.
class
google.cloud.bigquery.job.query.QueryJobAsynchronous job: query tables.
method
google.cloud.bigquery.job.query.QueryJob.configuration() -> QueryJobConfigThe configuration for this query job.
method
google.cloud.bigquery.job.query.QueryJob.query_id() -> Optional[str][Preview] ID of a completed query.
method
google.cloud.bigquery.job.query.QueryJob.schema() -> Optional[List[SchemaField]]The schema of the results.
method
google.cloud.bigquery.job.query.QueryJob.search_stats() -> Optional[SearchStats]Returns a SearchStats object.
class
google.cloud.bigquery.job.query.QueryJobConfigConfiguration options for query jobs.
method
google.cloud.bigquery.job.query.QueryJobConfig.connection_properties() -> List[ConnectionProperty]Connection properties.
method
google.cloud.bigquery.job.query.QueryJobConfig.maximum_billing_tier()int: Deprecated.
class
google.cloud.bigquery.job.query.QueryPlanEntryStepMap a single step in a query plan entry.
method
google.cloud.bigquery.job.query.QueryPlanEntryStep.from_api_repr(resource:dict) -> 'QueryPlanEntryStep'Factory: construct instance from the JSON repr.
class
google.cloud.bigquery.job.query.ScriptOptionsOptions controlling the execution of scripts.
method
google.cloud.bigquery.job.query.ScriptOptions.from_api_repr(resource:Dict[str, Any]) -> 'ScriptOptions'Factory: construct instance from the JSON repr.
method
google.cloud.bigquery.job.query.ScriptOptions.to_api_repr() -> Dict[str, Any]Construct the API resource representation.
class
google.cloud.bigquery.job.query.SearchStatsStatistics related to Search Queries.
class
google.cloud.bigquery.magics.line_arg_parser.lexer.AutoStrEnumBase enum class for for name=value str enums.
class
google.cloud.bigquery.magics.line_arg_parser.parser.ParserParser for the tokenized cell magic input line.
class
google.cloud.bigquery.model.ModelModel represents a machine learning model resource.
method
google.cloud.bigquery.model.Model.best_trial_id() -> Optional[int]The best trial_id across all training runs.
method
google.cloud.bigquery.model.Model.dataset_id() -> Optional[str]ID of dataset containing the model.
method
google.cloud.bigquery.model.Model.expires() -> Optional[datetime.datetime]The datetime when this model expires.
method
google.cloud.bigquery.model.Model.friendly_name() -> Optional[str]Title of the table (defaults to :data:`None`).
method
google.cloud.bigquery.model.Model.labels() -> Dict[str, str]Labels for the table.
method
google.cloud.bigquery.model.Model.location() -> Optional[str]The geographic location where the model resides.
method
google.cloud.bigquery.model.Model.model_id() -> Optional[str]The model ID.
method
google.cloud.bigquery.model.Model.model_type() -> strType of the model resource.
method
google.cloud.bigquery.model.Model.path() -> Optional[str]URL path for the model's APIs.
method
google.cloud.bigquery.model.Model.project() -> Optional[str]Project bound to the model.
method
google.cloud.bigquery.model.Model.reference() -> Optional['ModelReference']A model reference pointing to this model.
class
google.cloud.bigquery.model.ModelReferenceModelReferences are pointers to models.
method
google.cloud.bigquery.model.ModelReference.model_id()str: The model ID.
method
google.cloud.bigquery.model.ModelReference.path() -> strURL path for the model's APIs.
method
google.cloud.bigquery.model.ModelReference.project()str: Project bound to the model
class
google.cloud.bigquery.model.TransformColumnTransformColumn represents a transform column feature.
method
google.cloud.bigquery.model.TransformColumn.name() -> Optional[str]Name of the column.
method
google.cloud.bigquery.query.ArrayQueryParameter.from_api_repr(resource:dict) -> 'ArrayQueryParameter'Factory: construct parameter from JSON resource.
method
google.cloud.bigquery.query.ArrayQueryParameter.positional(array_type:str, values:list) -> 'ArrayQueryParameter'Factory for positional parameters.
class
google.cloud.bigquery.query.ArrayQueryParameterTypeType representation for array query parameters.
method
google.cloud.bigquery.query.RangeQueryParameter.from_api_repr(resource:dict) -> 'RangeQueryParameter'Factory: construct parameter from JSON resource.
class
google.cloud.bigquery.query.RangeQueryParameterTypeType representation for range query parameters.
method
google.cloud.bigquery.query.ScalarQueryParameter.from_api_repr(resource:dict) -> 'ScalarQueryParameter'Factory: construct parameter from JSON resource.
method
google.cloud.bigquery.query.ScalarQueryParameter.positional(type_:Union[str, ScalarQueryParameterType], value:_SCALAR_VALUE_TYPE) -> 'ScalarQueryParameter'Factory for positional paramater.
class
google.cloud.bigquery.query.ScalarQueryParameterTypeType representation for scalar query parameters.
method
google.cloud.bigquery.query.StructQueryParameter.from_api_repr(resource:dict) -> 'StructQueryParameter'Factory: construct parameter from JSON resource.
class
google.cloud.bigquery.query.StructQueryParameterTypeType representation for struct query parameters.
class
google.cloud.bigquery.query.UDFResourceDescribe a single user-defined function (UDF) resource.
class
google.cloud.bigquery.routine.routine.ExternalRuntimeOptionsOptions for the runtime of the external system.
method
google.cloud.bigquery.routine.routine.ExternalRuntimeOptions.container_cpu() -> Optional[int]Optional.
method
google.cloud.bigquery.routine.routine.ExternalRuntimeOptions.container_memory() -> Optional[str]Optional.
method
google.cloud.bigquery.routine.routine.ExternalRuntimeOptions.max_batching_rows() -> Optional[int]Optional.
method
google.cloud.bigquery.routine.routine.ExternalRuntimeOptions.runtime_connection() -> Optional[str]Optional.
method
google.cloud.bigquery.routine.routine.ExternalRuntimeOptions.runtime_version() -> Optional[str]Optional.
class
google.cloud.bigquery.routine.routine.RoutineResource representing a user-defined routine.
method
google.cloud.bigquery.routine.routine.Routine.body()str: The body of the routine.
method
google.cloud.bigquery.routine.routine.Routine.from_api_repr(resource:dict) -> 'Routine'Factory: construct a routine given its API representation.
method
google.cloud.bigquery.routine.routine.Routine.routine_id()str: The routine ID.
class
google.cloud.bigquery.routine.routine.RoutineReferenceA pointer to a routine.
method
google.cloud.bigquery.routine.routine.RoutineReference.routine_id()str: The routine ID.
class
google.cloud.bigquery.routine.routine.RoutineTypeThe fine-grained type of the routine.
class
google.cloud.bigquery.schema.FieldElementTypeRepresents the type of a field element.
class
google.cloud.bigquery.schema.PolicyTagListDefine Policy Tags for a column.
method
google.cloud.bigquery.schema.PolicyTagList.to_api_repr() -> dictReturn a dictionary representing this object.
class
google.cloud.bigquery.schema.SchemaFieldDescribe a single field within a table schema.
method
google.cloud.bigquery.schema.SchemaField.field_type() -> strstr: The type of the field.
method
google.cloud.bigquery.schema.SchemaField.name()str: The name of the field.
class
google.cloud.bigquery.schema.SerDeInfoSerializer and deserializer information.
method
google.cloud.bigquery.schema.SerDeInfo.name() -> Optional[str]Optional.
method
google.cloud.bigquery.schema.SerDeInfo.parameters() -> Optional[dict[str, str]]Optional.
method
google.cloud.bigquery.schema.SerDeInfo.serialization_library() -> strRequired.
method
google.cloud.bigquery.schema.SerDeInfo.to_api_repr() -> dictBuild an API representation of this object.
class
google.cloud.bigquery.standard_sql.StandardSqlDataTypeThe type of a variable, e.g., a function argument.
method
google.cloud.bigquery.standard_sql.StandardSqlDataType.type_kind() -> Optional[StandardSqlTypeNames]The top level type of this field.
class
google.cloud.bigquery.standard_sql.StandardSqlFieldA field or a column.
method
google.cloud.bigquery.standard_sql.StandardSqlField.name() -> Optional[str]The name of this field.
method
google.cloud.bigquery.standard_sql.StandardSqlField.type() -> Optional[StandardSqlDataType]The type of this parameter.
class
google.cloud.bigquery.standard_sql.StandardSqlStructTypeType of a struct field.
method
google.cloud.bigquery.standard_sql.StandardSqlStructType.fields() -> List[StandardSqlField]The fields in this struct.
class
google.cloud.bigquery.standard_sql.StandardSqlTableTypeA table type.
method
google.cloud.bigquery.standard_sql.StandardSqlTableType.columns() -> List[StandardSqlField]The columns in this table type.
method
google.cloud.bigquery.table.ForeignKey.from_api_repr(api_repr:Dict[str, Any]) -> 'ForeignKey'Create an instance from API representation.
method
google.cloud.bigquery.table.ForeignKey.to_api_repr() -> Dict[str, Any]Return a dictionary representing this object.
class
google.cloud.bigquery.table.PartitionRangeDefinition of the ranges for range partitioning.
class
google.cloud.bigquery.table.RangePartitioningRange-based partitioning configuration for a table.
class
google.cloud.bigquery.table.RowA BigQuery row.
method
google.cloud.bigquery.table.Row.get(key:str, default:Any=None) -> AnyReturn a value for key, with a default value if it does not exist.
method
google.cloud.bigquery.table.Row.items() -> Iterable[Tuple[str, Any]]Return items as ``(key, value)`` pairs.
method
google.cloud.bigquery.table.Row.keys() -> Iterable[str]Return the keys for using a row as a dict.
class
google.cloud.bigquery.table.StreamingBufferInformation about a table's streaming buffer.
method
google.cloud.bigquery.table.Table.clone_definition() -> Optional['CloneDefinition']Information about the clone.
method
google.cloud.bigquery.table.Table.foreign_type_info() -> Optional[_schema.ForeignTypeInfo]Optional.
method
google.cloud.bigquery.table.Table.from_string(full_table_id:str) -> 'Table'Construct a table from fully-qualified table ID.
method
google.cloud.bigquery.table.Table.snapshot_definition() -> Optional['SnapshotDefinition']Information about the snapshot.
class
google.cloud.bigquery.table.TableListItemA read-only table resource from a list operation.
method
google.cloud.bigquery.table.TableListItem.from_string(full_table_id:str) -> 'TableListItem'Construct a table from fully-qualified table ID.
class
google.cloud.bigquery.table.TableReferenceTableReferences are pointers to tables.
method
google.cloud.bigquery.table.TableReference.from_string(table_id:str, default_project:Optional[str]=None) -> 'TableReference'Construct a table reference from table ID string.
class
google.cloud.bigquery.table.TimePartitioningConfigures time-based partitioning for a table.
method
google.cloud.bigquery.table.TimePartitioning.to_api_repr() -> dictReturn a dictionary representing this object.
class
google.cloud.bigquery.table.TimePartitioningTypeSpecifies the type of time partitioning to perform.
class
google.cloud.bigquery_v2.types.model.DeleteModelRequestAttributes: project_id (str): Required.
class
google.cloud.bigquery_v2.types.model.GetModelRequestAttributes: project_id (str): Required.
class
google.cloud.bigquery_v2.types.model.ListModelsRequestAttributes: project_id (str): Required.
class
google.cloud.bigquery_v2.types.model.ModelAttributes: etag (str): Output only.
class
google.cloud.bigquery_v2.types.model.Model.ArimaFittingMetricsARIMA model fitting metrics.
class
google.cloud.bigquery_v2.types.model.Model.ClusteringMetricsEvaluation metrics for clustering models.
class
google.cloud.bigquery_v2.types.model.Model.DataSplitResultData split result.
class
google.cloud.bigquery_v2.types.model.Model.EvaluationMetricsEvaluation metrics of a model.
class
google.cloud.bigquery_v2.types.model.Model.GlobalExplanation.ExplanationExplanation for a single feature.
class
google.cloud.bigquery_v2.types.model.Model.LossTypeLoss metric to evaluate model training performance.
class
google.cloud.bigquery_v2.types.model.Model.ModelTypeIndicates the type of the Model.
class
google.cloud.bigquery_v2.types.model.Model.TrainingRun.IterationResult.ArimaResult(Auto-)arima fitting result.
class
google.cloud.bigquery_v2.types.model.Model.TrainingRun.IterationResult.ArimaResult.ArimaCoefficientsArima coefficients.
class
google.cloud.bigquery_v2.types.model.Model.TrainingRun.IterationResult.ArimaResult.ArimaModelInfoArima model information.
class
google.cloud.bigquery_v2.types.model.Model.TrainingRun.TrainingOptionsOptions used in model training.
class
google.cloud.bigquery_v2.types.model.PatchModelRequestAttributes: project_id (str): Required.
class
google.cloud.bigquery_v2.types.model_reference.ModelReferenceId path of a model.
class
google.cloud.bigquery_v2.types.standard_sql.StandardSqlFieldA field or a column.
class
google.cloud.bigquery_v2.types.table_reference.TableReferenceAttributes: project_id (str): Required.
この情報について
掲載しているシグネチャは googleapis/python-bigquery の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。