Commitdca2e4c

authored

docs: add documents for QueryPlanEntry and QueryPlanEntryStep (#344)

1 parentc9823d9 commitdca2e4cCopy full SHA for dca2e4c

File tree

-4

lines changed

-4

lines changed

Lines changed: 2 additions & 0 deletions

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -2844,7 +2844,7 @@ def query_plan(self):`
`2844`	`2844`	`https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatistics2.FIELDS.query_plan`
`2845`	`2845`
`2846`	`2846`	`Returns:`
`2847`		`- List[QueryPlanEntry]:`
	`2847`	`+ List[google.cloud.bigquery.job.QueryPlanEntry]:`
`2848`	`2848`	`mappings describing the query plan, or an empty list`
`2849`	`2849`	`if the query has not yet completed.`
`2850`	`2850`	`"""`
`@@ -3418,7 +3418,6 @@ class QueryPlanEntryStep(object):`
`3418`	`3418`
`3419`	`3419`	`Args:`
`3420`	`3420`	`kind (str): step type.`
`3421`		`-`
`3422`	`3421`	`substeps (List): names of substeps.`
`3423`	`3422`	`"""`
`3424`	`3423`
`@@ -3434,7 +3433,8 @@ def from_api_repr(cls, resource):`
`3434`	`3433`	`resource (Dict): JSON representation of the entry.`
`3435`	`3434`
`3436`	`3435`	`Returns:`
`3437`		`- QueryPlanEntryStep: new instance built from the resource.`
	`3436`	`+ google.cloud.bigquery.job.QueryPlanEntryStep:`
	`3437`	`+ New instance built from the resource.`
`3438`	`3438`	`"""`
`3439`	`3439`	`returncls(kind=resource.get("kind"),substeps=resource.get("substeps", ()))`
`3440`	`3440`
`@@ -3464,7 +3464,7 @@ def from_api_repr(cls, resource):`
`3464`	`3464`	`ExplainQueryStage representation returned from API.`
`3465`	`3465`
`3466`	`3466`	`Returns:`
`3467`		`- google.cloud.bigquery.QueryPlanEntry:`
	`3467`	`+ google.cloud.bigquery.job.QueryPlanEntry:`
`3468`	`3468`	Query plan entry parsed from ``resource``.
`3469`	`3469`	`"""`
`3470`	`3470`	`entry=cls()`

Comments

(0)