forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtable.html
More file actions
1256 lines (1031 loc) · 125 KB
/
Copy pathtable.html
File metadata and controls
1256 lines (1031 loc) · 125 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>gcloud.bigquery.table — gcloud 0.18.0 documentation</title>
<link rel="stylesheet" href="../../../_static/css/main.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/normalize.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.18.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/js/vendor/modernizr-2.6.2.min.js"></script>
<link rel="shortcut icon" href="../../../_static/favicon.ico"/>
<link rel="top" title="gcloud 0.18.0 documentation" href="../../../index.html" />
<link rel="up" title="Module code" href="../../index.html" />
</head>
<body role="document">
<header class="page-header fixed" role="banner">
<h1 class="logo">
<a href="index.html" title="back to home">
<img src="../../../_static/images/logo.svg" alt="Google Cloud Platform" />
<span class="gcloud">gcloud</span>
</a>
</h1>
<nav class="main-nav">
<div class="nav-current">Python</div>
<ul class="menu">
<li>
<a href="http://googlecloudplatform.github.io/google-cloud-dotnet" title=".NET docs page">
<img src="../../../_static/images/icon-lang-dotnet.svg" alt=".NET icon" class="menu-icon" />
.NET
</a>
</li>
<li>
<a href="
https://googlecloudplatform.github.io/gcloud-java/" title="gcloud-java page">
<img src="../../../_static/images/icon-lang-java-duke.svg" alt="Duke icon" class="menu-icon" />
Java
</a>
</li>
<li>
<a href="
https://googlecloudplatform.github.io/gcloud-node/#/docs" title="Node.js docs page">
<img src="../../../_static/images/icon-lang-nodejs.svg" alt="Node.js icon" class="menu-icon" />
Node.js
</a>
</li>
<li>
<a href="
https://googlecloudplatform.github.io/gcloud-php/" title="PHP docs page">
<img src="../../../_static/images/icon-lang-php.svg" alt="PHP icon" class="menu-icon" />
PHP
</a>
</li>
<li>
<a href="#" title="Python docs page">
<img src="../../../_static/images/icon-lang-python.svg" alt="Python icon" class="menu-icon" />
Python
</a>
</li>
<li>
<a href="
http://googlecloudplatform.github.io/gcloud-ruby/docs/latest" title="Ruby docs page">
<img src="../../../_static/images/icon-lang-ruby.svg" alt="Ruby icon" class="menu-icon" />
Ruby
</a>
</li>
</ul>
</nav><!-- end of .main-nav -->
<a href="https://github.com/GoogleCloudPlatform/gcloud-python/issues/new?title=%5BDocumentation+Issue%5D+&body=Page+Name%3A+_modules/gcloud/bigquery/table%0ARelease%3A%200.18.0" target="_blank" class="v-btn" id="file-issue">
<img src="_static/images/icon-link-github.svg" />
Report an Issue
</a>
</header><!-- end of .page-header -->
<article class="main lang-page" role="main">
<header class="docs-header">
<div class="versions">
<a href="/gcloud-python/versions.html" class="v-btn">
<img src="_static/images/icon-arrow-bullet.svg" />
Version History (0.18.0)
</a>
</div><!-- end of .versions -->
<div>
<a href="https://github.com/GoogleCloudPlatform/gcloud-python/issues/new?title=%5BDocumentation+Issue%5D+" target="_blank" class="v-btn" id="file-issue-secondary">
<img src="_static/images/icon-link-github.svg" />
Report an Issue
</a>
</div>
</header>
<section class="content">
<h1>Source code for gcloud.bigquery.table</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright 2015 Google Inc. All rights reserved.</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
<span class="c1"># you may not use this file except in compliance with the License.</span>
<span class="c1"># You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="sd">"""Define API Datasets."""</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">from</span> <span class="nn">gcloud._helpers</span> <span class="k">import</span> <span class="n">_datetime_from_microseconds</span>
<span class="kn">from</span> <span class="nn">gcloud._helpers</span> <span class="k">import</span> <span class="n">_microseconds_from_datetime</span>
<span class="kn">from</span> <span class="nn">gcloud._helpers</span> <span class="k">import</span> <span class="n">_millis_from_datetime</span>
<span class="kn">from</span> <span class="nn">gcloud.exceptions</span> <span class="k">import</span> <span class="n">NotFound</span>
<span class="kn">from</span> <span class="nn">gcloud.streaming.http_wrapper</span> <span class="k">import</span> <span class="n">Request</span>
<span class="kn">from</span> <span class="nn">gcloud.streaming.http_wrapper</span> <span class="k">import</span> <span class="n">make_api_request</span>
<span class="kn">from</span> <span class="nn">gcloud.streaming.transfer</span> <span class="k">import</span> <span class="n">RESUMABLE_UPLOAD</span>
<span class="kn">from</span> <span class="nn">gcloud.streaming.transfer</span> <span class="k">import</span> <span class="n">Upload</span>
<span class="kn">from</span> <span class="nn">gcloud.bigquery._helpers</span> <span class="k">import</span> <span class="n">_rows_from_json</span>
<span class="n">_MARKER</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
<div class="viewcode-block" id="SchemaField"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.SchemaField">[docs]</a><span class="k">class</span> <span class="nc">SchemaField</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Describe a single field within a table schema.</span>
<span class="sd"> :type name: str</span>
<span class="sd"> :param name: the name of the field</span>
<span class="sd"> :type field_type: str</span>
<span class="sd"> :param field_type: the type of the field (one of 'STRING', 'INTEGER',</span>
<span class="sd"> 'FLOAT', 'BOOLEAN', 'TIMESTAMP' or 'RECORD')</span>
<span class="sd"> :type mode: str</span>
<span class="sd"> :param mode: the type of the field (one of 'NULLABLE', 'REQUIRED',</span>
<span class="sd"> or 'REPEATED')</span>
<span class="sd"> :type description: str</span>
<span class="sd"> :param description: optional description for the field</span>
<span class="sd"> :type fields: list of :class:`SchemaField`, or None</span>
<span class="sd"> :param fields: subfields (requires ``field_type`` of 'RECORD').</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">field_type</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">'NULLABLE'</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">fields</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">field_type</span> <span class="o">=</span> <span class="n">field_type</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mode</span> <span class="o">=</span> <span class="n">mode</span>
<span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="n">description</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fields</span> <span class="o">=</span> <span class="n">fields</span>
<span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">name</span> <span class="ow">and</span>
<span class="bp">self</span><span class="o">.</span><span class="n">field_type</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">field_type</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">and</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mode</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">mode</span> <span class="ow">and</span>
<span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">description</span> <span class="ow">and</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fields</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">fields</span><span class="p">)</span></div>
<div class="viewcode-block" id="Table"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table">[docs]</a><span class="k">class</span> <span class="nc">Table</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Tables represent a set of rows whose values correspond to a schema.</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tables</span>
<span class="sd"> :type name: str</span>
<span class="sd"> :param name: the name of the table</span>
<span class="sd"> :type dataset: :class:`gcloud.bigquery.dataset.Dataset`</span>
<span class="sd"> :param dataset: The dataset which contains the table.</span>
<span class="sd"> :type schema: list of :class:`SchemaField`</span>
<span class="sd"> :param schema: The table's schema</span>
<span class="sd"> """</span>
<span class="n">_schema</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">dataset</span><span class="p">,</span> <span class="n">schema</span><span class="o">=</span><span class="p">()):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span> <span class="o">=</span> <span class="n">dataset</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_properties</span> <span class="o">=</span> <span class="p">{}</span>
<span class="c1"># Let the @property do validation.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="n">schema</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">project</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Project bound to the table.</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> :returns: the project (derived from the dataset).</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">project</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">dataset_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Name of dataset containing the table.</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> :returns: the ID (derived from the dataset).</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">name</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""URL path for the table's APIs.</span>
<span class="sd"> :rtype: str</span>
<span class="sd"> :returns: the path based on project and dataste name.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="s1">'</span><span class="si">%s</span><span class="s1">/tables/</span><span class="si">%s</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">schema</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Table's schema.</span>
<span class="sd"> :rtype: list of :class:`SchemaField`</span>
<span class="sd"> :returns: fields describing the schema</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_schema</span><span class="p">)</span>
<span class="nd">@schema</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">schema</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Update table's schema</span>
<span class="sd"> :type value: list of :class:`SchemaField`</span>
<span class="sd"> :param value: fields describing the schema</span>
<span class="sd"> :raises: TypeError if 'value' is not a sequence, or ValueError if</span>
<span class="sd"> any item in the sequence is not a SchemaField</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">SchemaField</span><span class="p">)</span> <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">value</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'Schema items must be fields'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_schema</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">created</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Datetime at which the table was created.</span>
<span class="sd"> :rtype: ``datetime.datetime``, or ``NoneType``</span>
<span class="sd"> :returns: the creation time (None until set from the server).</span>
<span class="sd"> """</span>
<span class="n">creation_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'creationTime'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">creation_time</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># creation_time will be in milliseconds.</span>
<span class="k">return</span> <span class="n">_datetime_from_microseconds</span><span class="p">(</span><span class="mf">1000.0</span> <span class="o">*</span> <span class="n">creation_time</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">etag</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""ETag for the table resource.</span>
<span class="sd"> :rtype: str, or ``NoneType``</span>
<span class="sd"> :returns: the ETag (None until set from the server).</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'etag'</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">modified</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Datetime at which the table was last modified.</span>
<span class="sd"> :rtype: ``datetime.datetime``, or ``NoneType``</span>
<span class="sd"> :returns: the modification time (None until set from the server).</span>
<span class="sd"> """</span>
<span class="n">modified_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'lastModifiedTime'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">modified_time</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># modified_time will be in milliseconds.</span>
<span class="k">return</span> <span class="n">_datetime_from_microseconds</span><span class="p">(</span><span class="mf">1000.0</span> <span class="o">*</span> <span class="n">modified_time</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">num_bytes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The size of the table in bytes.</span>
<span class="sd"> :rtype: integer, or ``NoneType``</span>
<span class="sd"> :returns: the byte count (None until set from the server).</span>
<span class="sd"> """</span>
<span class="n">num_bytes_as_str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'numBytes'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">num_bytes_as_str</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">num_bytes_as_str</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">num_rows</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The number of rows in the table.</span>
<span class="sd"> :rtype: integer, or ``NoneType``</span>
<span class="sd"> :returns: the row count (None until set from the server).</span>
<span class="sd"> """</span>
<span class="n">num_rows_as_str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'numRows'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">num_rows_as_str</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">num_rows_as_str</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">self_link</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""URL for the table resource.</span>
<span class="sd"> :rtype: str, or ``NoneType``</span>
<span class="sd"> :returns: the URL (None until set from the server).</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'selfLink'</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">table_id</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""ID for the table resource.</span>
<span class="sd"> :rtype: str, or ``NoneType``</span>
<span class="sd"> :returns: the ID (None until set from the server).</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'id'</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">table_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The type of the table.</span>
<span class="sd"> Possible values are "TABLE" or "VIEW".</span>
<span class="sd"> :rtype: str, or ``NoneType``</span>
<span class="sd"> :returns: the URL (None until set from the server).</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'type'</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Description of the table.</span>
<span class="sd"> :rtype: str, or ``NoneType``</span>
<span class="sd"> :returns: The description as set by the user, or None (the default).</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'description'</span><span class="p">)</span>
<span class="nd">@description</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Update description of the table.</span>
<span class="sd"> :type value: str, or ``NoneType``</span>
<span class="sd"> :param value: new description</span>
<span class="sd"> :raises: ValueError for invalid value types.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Pass a string, or None"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="p">[</span><span class="s1">'description'</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">expires</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Datetime at which the table will be removed.</span>
<span class="sd"> :rtype: ``datetime.datetime``, or ``NoneType``</span>
<span class="sd"> :returns: the expiration time, or None</span>
<span class="sd"> """</span>
<span class="n">expiration_time</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'expirationTime'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">expiration_time</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># expiration_time will be in milliseconds.</span>
<span class="k">return</span> <span class="n">_datetime_from_microseconds</span><span class="p">(</span><span class="mf">1000.0</span> <span class="o">*</span> <span class="n">expiration_time</span><span class="p">)</span>
<span class="nd">@expires</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">expires</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Update datetime at which the table will be removed.</span>
<span class="sd"> :type value: ``datetime.datetime``, or ``NoneType``</span>
<span class="sd"> :param value: the new expiration time, or None</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Pass a datetime, or None"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="p">[</span><span class="s1">'expirationTime'</span><span class="p">]</span> <span class="o">=</span> <span class="n">_millis_from_datetime</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">friendly_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Title of the table.</span>
<span class="sd"> :rtype: str, or ``NoneType``</span>
<span class="sd"> :returns: The name as set by the user, or None (the default).</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'friendlyName'</span><span class="p">)</span>
<span class="nd">@friendly_name</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">friendly_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Update title of the table.</span>
<span class="sd"> :type value: str, or ``NoneType``</span>
<span class="sd"> :param value: new title</span>
<span class="sd"> :raises: ValueError for invalid value types.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Pass a string, or None"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="p">[</span><span class="s1">'friendlyName'</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">location</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Location in which the table is hosted.</span>
<span class="sd"> :rtype: str, or ``NoneType``</span>
<span class="sd"> :returns: The location as set by the user, or None (the default).</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'location'</span><span class="p">)</span>
<span class="nd">@location</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">location</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Update location in which the table is hosted.</span>
<span class="sd"> :type value: str, or ``NoneType``</span>
<span class="sd"> :param value: new location</span>
<span class="sd"> :raises: ValueError for invalid value types.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Pass a string, or None"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="p">[</span><span class="s1">'location'</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">view_query</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""SQL query defining the table as a view.</span>
<span class="sd"> :rtype: str, or ``NoneType``</span>
<span class="sd"> :returns: The query as set by the user, or None (the default).</span>
<span class="sd"> """</span>
<span class="n">view</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'view'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">view</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">view</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'query'</span><span class="p">)</span>
<span class="nd">@view_query</span><span class="o">.</span><span class="n">setter</span>
<span class="k">def</span> <span class="nf">view_query</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Update SQL query defining the table as a view.</span>
<span class="sd"> :type value: str</span>
<span class="sd"> :param value: new query</span>
<span class="sd"> :raises: ValueError for invalid value types.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Pass a string"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="p">[</span><span class="s1">'view'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'query'</span><span class="p">:</span> <span class="n">value</span><span class="p">}</span>
<span class="nd">@view_query</span><span class="o">.</span><span class="n">deleter</span>
<span class="k">def</span> <span class="nf">view_query</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Delete SQL query defining the table as a view."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'view'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="Table.from_api_repr"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.from_api_repr">[docs]</a> <span class="k">def</span> <span class="nf">from_api_repr</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">resource</span><span class="p">,</span> <span class="n">dataset</span><span class="p">):</span>
<span class="sd">"""Factory: construct a table given its API representation</span>
<span class="sd"> :type resource: dict</span>
<span class="sd"> :param resource: table resource representation returned from the API</span>
<span class="sd"> :type dataset: :class:`gcloud.bigquery.dataset.Dataset`</span>
<span class="sd"> :param dataset: The dataset containing the table.</span>
<span class="sd"> :rtype: :class:`gcloud.bigquery.table.Table`</span>
<span class="sd"> :returns: Table parsed from ``resource``.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="p">(</span><span class="s1">'tableReference'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">resource</span> <span class="ow">or</span>
<span class="s1">'tableId'</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">resource</span><span class="p">[</span><span class="s1">'tableReference'</span><span class="p">]):</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="s1">'Resource lacks required identity information:'</span>
<span class="s1">'["tableReference"]["tableId"]'</span><span class="p">)</span>
<span class="n">table_name</span> <span class="o">=</span> <span class="n">resource</span><span class="p">[</span><span class="s1">'tableReference'</span><span class="p">][</span><span class="s1">'tableId'</span><span class="p">]</span>
<span class="n">table</span> <span class="o">=</span> <span class="n">cls</span><span class="p">(</span><span class="n">table_name</span><span class="p">,</span> <span class="n">dataset</span><span class="o">=</span><span class="n">dataset</span><span class="p">)</span>
<span class="n">table</span><span class="o">.</span><span class="n">_set_properties</span><span class="p">(</span><span class="n">resource</span><span class="p">)</span>
<span class="k">return</span> <span class="n">table</span></div>
<span class="k">def</span> <span class="nf">_require_client</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
<span class="sd">"""Check client or verify over-ride.</span>
<span class="sd"> :type client: :class:`gcloud.bigquery.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: the client to use. If not passed, falls back to the</span>
<span class="sd"> ``client`` stored on the current dataset.</span>
<span class="sd"> :rtype: :class:`gcloud.bigquery.client.Client`</span>
<span class="sd"> :returns: The client passed in or the currently bound client.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">client</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">_client</span>
<span class="k">return</span> <span class="n">client</span>
<span class="k">def</span> <span class="nf">_set_properties</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">api_response</span><span class="p">):</span>
<span class="sd">"""Update properties from resource in body of ``api_response``</span>
<span class="sd"> :type api_response: httplib2.Response</span>
<span class="sd"> :param api_response: response returned from an API call</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
<span class="n">cleaned</span> <span class="o">=</span> <span class="n">api_response</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">schema</span> <span class="o">=</span> <span class="n">cleaned</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">'schema'</span><span class="p">,</span> <span class="p">{</span><span class="s1">'fields'</span><span class="p">:</span> <span class="p">()})</span>
<span class="bp">self</span><span class="o">.</span><span class="n">schema</span> <span class="o">=</span> <span class="n">_parse_schema_resource</span><span class="p">(</span><span class="n">schema</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">'creationTime'</span> <span class="ow">in</span> <span class="n">cleaned</span><span class="p">:</span>
<span class="n">cleaned</span><span class="p">[</span><span class="s1">'creationTime'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">cleaned</span><span class="p">[</span><span class="s1">'creationTime'</span><span class="p">])</span>
<span class="k">if</span> <span class="s1">'lastModifiedTime'</span> <span class="ow">in</span> <span class="n">cleaned</span><span class="p">:</span>
<span class="n">cleaned</span><span class="p">[</span><span class="s1">'lastModifiedTime'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">cleaned</span><span class="p">[</span><span class="s1">'lastModifiedTime'</span><span class="p">])</span>
<span class="k">if</span> <span class="s1">'expirationTime'</span> <span class="ow">in</span> <span class="n">cleaned</span><span class="p">:</span>
<span class="n">cleaned</span><span class="p">[</span><span class="s1">'expirationTime'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">cleaned</span><span class="p">[</span><span class="s1">'expirationTime'</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_properties</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">cleaned</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_build_resource</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Generate a resource for ``create`` or ``update``."""</span>
<span class="n">resource</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'tableReference'</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">'projectId'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">project</span><span class="p">,</span>
<span class="s1">'datasetId'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
<span class="s1">'tableId'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">},</span>
<span class="p">}</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">resource</span><span class="p">[</span><span class="s1">'description'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">description</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">expires</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">_millis_from_datetime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">expires</span><span class="p">)</span>
<span class="n">resource</span><span class="p">[</span><span class="s1">'expirationTime'</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">friendly_name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">resource</span><span class="p">[</span><span class="s1">'friendlyName'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">friendly_name</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">resource</span><span class="p">[</span><span class="s1">'location'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">location</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">view_query</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">view</span> <span class="o">=</span> <span class="n">resource</span><span class="p">[</span><span class="s1">'view'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">view</span><span class="p">[</span><span class="s1">'query'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">view_query</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_schema</span><span class="p">:</span>
<span class="n">resource</span><span class="p">[</span><span class="s1">'schema'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'fields'</span><span class="p">:</span> <span class="n">_build_schema_resource</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_schema</span><span class="p">)</span>
<span class="p">}</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Set either 'view_query' or 'schema'."</span><span class="p">)</span>
<span class="k">return</span> <span class="n">resource</span>
<div class="viewcode-block" id="Table.create"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""API call: create the dataset via a PUT request</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tables/insert</span>
<span class="sd"> :type client: :class:`gcloud.bigquery.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: the client to use. If not passed, falls back to the</span>
<span class="sd"> ``client`` stored on the current dataset.</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_require_client</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
<span class="n">path</span> <span class="o">=</span> <span class="s1">'/projects/</span><span class="si">%s</span><span class="s1">/datasets/</span><span class="si">%s</span><span class="s1">/tables'</span> <span class="o">%</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">project</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="n">api_response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span>
<span class="n">method</span><span class="o">=</span><span class="s1">'POST'</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_build_resource</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_properties</span><span class="p">(</span><span class="n">api_response</span><span class="p">)</span></div>
<div class="viewcode-block" id="Table.exists"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.exists">[docs]</a> <span class="k">def</span> <span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""API call: test for the existence of the table via a GET request</span>
<span class="sd"> See</span>
<span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tables/get</span>
<span class="sd"> :type client: :class:`gcloud.bigquery.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: the client to use. If not passed, falls back to the</span>
<span class="sd"> ``client`` stored on the current dataset.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> :returns: Boolean indicating existence of the table.</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_require_client</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">client</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s1">'GET'</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
<span class="n">query_params</span><span class="o">=</span><span class="p">{</span><span class="s1">'fields'</span><span class="p">:</span> <span class="s1">'id'</span><span class="p">})</span>
<span class="k">except</span> <span class="n">NotFound</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="Table.reload"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.reload">[docs]</a> <span class="k">def</span> <span class="nf">reload</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""API call: refresh table properties via a GET request</span>
<span class="sd"> See</span>
<span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tables/get</span>
<span class="sd"> :type client: :class:`gcloud.bigquery.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: the client to use. If not passed, falls back to the</span>
<span class="sd"> ``client`` stored on the current dataset.</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_require_client</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
<span class="n">api_response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span>
<span class="n">method</span><span class="o">=</span><span class="s1">'GET'</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_properties</span><span class="p">(</span><span class="n">api_response</span><span class="p">)</span></div>
<div class="viewcode-block" id="Table.patch"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.patch">[docs]</a> <span class="k">def</span> <span class="nf">patch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">friendly_name</span><span class="o">=</span><span class="n">_MARKER</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">_MARKER</span><span class="p">,</span>
<span class="n">location</span><span class="o">=</span><span class="n">_MARKER</span><span class="p">,</span>
<span class="n">expires</span><span class="o">=</span><span class="n">_MARKER</span><span class="p">,</span>
<span class="n">view_query</span><span class="o">=</span><span class="n">_MARKER</span><span class="p">,</span>
<span class="n">schema</span><span class="o">=</span><span class="n">_MARKER</span><span class="p">):</span>
<span class="sd">"""API call: update individual table properties via a PATCH request</span>
<span class="sd"> See</span>
<span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tables/patch</span>
<span class="sd"> :type client: :class:`gcloud.bigquery.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: the client to use. If not passed, falls back to the</span>
<span class="sd"> ``client`` stored on the current dataset.</span>
<span class="sd"> :type friendly_name: str or ``NoneType``</span>
<span class="sd"> :param friendly_name: point in time at which the table expires.</span>
<span class="sd"> :type description: str or ``NoneType``</span>
<span class="sd"> :param description: point in time at which the table expires.</span>
<span class="sd"> :type location: str or ``NoneType``</span>
<span class="sd"> :param location: point in time at which the table expires.</span>
<span class="sd"> :type expires: :class:`datetime.datetime` or ``NoneType``</span>
<span class="sd"> :param expires: point in time at which the table expires.</span>
<span class="sd"> :type view_query: str</span>
<span class="sd"> :param view_query: SQL query defining the table as a view</span>
<span class="sd"> :type schema: list of :class:`SchemaField`</span>
<span class="sd"> :param schema: fields describing the schema</span>
<span class="sd"> :raises: ValueError for invalid value types.</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_require_client</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
<span class="n">partial</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="n">expires</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_MARKER</span><span class="p">:</span>
<span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">expires</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">)</span> <span class="ow">and</span>
<span class="n">expires</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Pass a datetime, or None"</span><span class="p">)</span>
<span class="n">partial</span><span class="p">[</span><span class="s1">'expirationTime'</span><span class="p">]</span> <span class="o">=</span> <span class="n">_millis_from_datetime</span><span class="p">(</span><span class="n">expires</span><span class="p">)</span>
<span class="k">if</span> <span class="n">description</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_MARKER</span><span class="p">:</span>
<span class="n">partial</span><span class="p">[</span><span class="s1">'description'</span><span class="p">]</span> <span class="o">=</span> <span class="n">description</span>
<span class="k">if</span> <span class="n">friendly_name</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_MARKER</span><span class="p">:</span>
<span class="n">partial</span><span class="p">[</span><span class="s1">'friendlyName'</span><span class="p">]</span> <span class="o">=</span> <span class="n">friendly_name</span>
<span class="k">if</span> <span class="n">location</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_MARKER</span><span class="p">:</span>
<span class="n">partial</span><span class="p">[</span><span class="s1">'location'</span><span class="p">]</span> <span class="o">=</span> <span class="n">location</span>
<span class="k">if</span> <span class="n">view_query</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_MARKER</span><span class="p">:</span>
<span class="k">if</span> <span class="n">view_query</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">partial</span><span class="p">[</span><span class="s1">'view'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">partial</span><span class="p">[</span><span class="s1">'view'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'query'</span><span class="p">:</span> <span class="n">view_query</span><span class="p">}</span>
<span class="k">if</span> <span class="n">schema</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">_MARKER</span><span class="p">:</span>
<span class="k">if</span> <span class="n">schema</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">partial</span><span class="p">[</span><span class="s1">'schema'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">partial</span><span class="p">[</span><span class="s1">'schema'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'fields'</span><span class="p">:</span> <span class="n">_build_schema_resource</span><span class="p">(</span><span class="n">schema</span><span class="p">)}</span>
<span class="n">api_response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span>
<span class="n">method</span><span class="o">=</span><span class="s1">'PATCH'</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">partial</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_properties</span><span class="p">(</span><span class="n">api_response</span><span class="p">)</span></div>
<div class="viewcode-block" id="Table.update"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""API call: update table properties via a PUT request</span>
<span class="sd"> See</span>
<span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tables/update</span>
<span class="sd"> :type client: :class:`gcloud.bigquery.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: the client to use. If not passed, falls back to the</span>
<span class="sd"> ``client`` stored on the current dataset.</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_require_client</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
<span class="n">api_response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span>
<span class="n">method</span><span class="o">=</span><span class="s1">'PUT'</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_build_resource</span><span class="p">())</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_set_properties</span><span class="p">(</span><span class="n">api_response</span><span class="p">)</span></div>
<div class="viewcode-block" id="Table.delete"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""API call: delete the table via a DELETE request</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tables/delete</span>
<span class="sd"> :type client: :class:`gcloud.bigquery.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: the client to use. If not passed, falls back to the</span>
<span class="sd"> ``client`` stored on the current dataset.</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_require_client</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
<span class="n">client</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s1">'DELETE'</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span></div>
<div class="viewcode-block" id="Table.fetch_data"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.fetch_data">[docs]</a> <span class="k">def</span> <span class="nf">fetch_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">max_results</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">page_token</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""API call: fetch the table data via a GET request</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tabledata/list</span>
<span class="sd"> .. note::</span>
<span class="sd"> This method assumes that its instance's ``schema`` attribute is</span>
<span class="sd"> up-to-date with the schema as defined on the back-end: if the</span>
<span class="sd"> two schemas are not identical, the values returned may be</span>
<span class="sd"> incomplete. To ensure that the local copy of the schema is</span>
<span class="sd"> up-to-date, call the table's ``reload`` method.</span>
<span class="sd"> :type max_results: integer or ``NoneType``</span>
<span class="sd"> :param max_results: maximum number of rows to return.</span>
<span class="sd"> :type page_token: str or ``NoneType``</span>
<span class="sd"> :param page_token: token representing a cursor into the table's rows.</span>
<span class="sd"> :type client: :class:`gcloud.bigquery.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: the client to use. If not passed, falls back to the</span>
<span class="sd"> ``client`` stored on the current dataset.</span>
<span class="sd"> :rtype: tuple</span>
<span class="sd"> :returns: ``(row_data, total_rows, page_token)``, where ``row_data``</span>
<span class="sd"> is a list of tuples, one per result row, containing only</span>
<span class="sd"> the values; ``total_rows`` is a count of the total number</span>
<span class="sd"> of rows in the table; and ``page_token`` is an opaque</span>
<span class="sd"> string which can be used to fetch the next batch of rows</span>
<span class="sd"> (``None`` if no further batches can be fetched).</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_require_client</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
<span class="n">params</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="n">max_results</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s1">'maxResults'</span><span class="p">]</span> <span class="o">=</span> <span class="n">max_results</span>
<span class="k">if</span> <span class="n">page_token</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">params</span><span class="p">[</span><span class="s1">'pageToken'</span><span class="p">]</span> <span class="o">=</span> <span class="n">page_token</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s1">'GET'</span><span class="p">,</span>
<span class="n">path</span><span class="o">=</span><span class="s1">'</span><span class="si">%s</span><span class="s1">/data'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
<span class="n">query_params</span><span class="o">=</span><span class="n">params</span><span class="p">)</span>
<span class="n">total_rows</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'totalRows'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">total_rows</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">total_rows</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">total_rows</span><span class="p">)</span>
<span class="n">page_token</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'pageToken'</span><span class="p">)</span>
<span class="n">rows_data</span> <span class="o">=</span> <span class="n">_rows_from_json</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'rows'</span><span class="p">,</span> <span class="p">()),</span> <span class="bp">self</span><span class="o">.</span><span class="n">_schema</span><span class="p">)</span>
<span class="k">return</span> <span class="n">rows_data</span><span class="p">,</span> <span class="n">total_rows</span><span class="p">,</span> <span class="n">page_token</span></div>
<div class="viewcode-block" id="Table.insert_data"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.insert_data">[docs]</a> <span class="k">def</span> <span class="nf">insert_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">rows</span><span class="p">,</span>
<span class="n">row_ids</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">skip_invalid_rows</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">ignore_unknown_values</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">template_suffix</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""API call: insert table data via a POST request</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/bigquery/docs/reference/v2/tabledata/insertAll</span>
<span class="sd"> :type rows: list of tuples</span>
<span class="sd"> :param rows: Row data to be inserted. Each tuple should contain data</span>
<span class="sd"> for each schema field on the current table and in the</span>
<span class="sd"> same order as the schema fields.</span>
<span class="sd"> :type row_ids: list of string</span>
<span class="sd"> :param row_ids: Unique ids, one per row being inserted. If not</span>
<span class="sd"> passed, no de-duplication occurs.</span>
<span class="sd"> :type skip_invalid_rows: boolean or ``NoneType``</span>
<span class="sd"> :param skip_invalid_rows: skip rows w/ invalid data?</span>
<span class="sd"> :type ignore_unknown_values: boolean or ``NoneType``</span>
<span class="sd"> :param ignore_unknown_values: ignore columns beyond schema?</span>
<span class="sd"> :type template_suffix: str or ``NoneType``</span>
<span class="sd"> :param template_suffix: treat ``name`` as a template table and provide</span>
<span class="sd"> a suffix. BigQuery will create the table</span>
<span class="sd"> ``<name> + <template_suffix>`` based on the</span>
<span class="sd"> schema of the template table. See:</span>
<span class="sd"> https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables</span>
<span class="sd"> :type client: :class:`gcloud.bigquery.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: the client to use. If not passed, falls back to the</span>
<span class="sd"> ``client`` stored on the current dataset.</span>
<span class="sd"> :rtype: list of mappings</span>
<span class="sd"> :returns: One mapping per row with insert errors: the "index" key</span>
<span class="sd"> identifies the row, and the "errors" key contains a list</span>
<span class="sd"> of the mappings describing one or more problems with the</span>
<span class="sd"> row.</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_require_client</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
<span class="n">rows_info</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'rows'</span><span class="p">:</span> <span class="n">rows_info</span><span class="p">}</span>
<span class="k">for</span> <span class="n">index</span><span class="p">,</span> <span class="n">row</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">rows</span><span class="p">):</span>
<span class="n">row_info</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">field</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_schema</span><span class="p">,</span> <span class="n">row</span><span class="p">):</span>
<span class="k">if</span> <span class="n">field</span><span class="o">.</span><span class="n">field_type</span> <span class="o">==</span> <span class="s1">'TIMESTAMP'</span> <span class="ow">and</span> <span class="n">value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># BigQuery stores TIMESTAMP data internally as a</span>
<span class="c1"># UNIX timestamp with microsecond precision.</span>
<span class="c1"># Specifies the number of seconds since the epoch.</span>
<span class="n">value</span> <span class="o">=</span> <span class="n">_microseconds_from_datetime</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o">*</span> <span class="mi">1</span><span class="n">e</span><span class="o">-</span><span class="mi">6</span>
<span class="n">row_info</span><span class="p">[</span><span class="n">field</span><span class="o">.</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="n">info</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'json'</span><span class="p">:</span> <span class="n">row_info</span><span class="p">}</span>
<span class="k">if</span> <span class="n">row_ids</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">info</span><span class="p">[</span><span class="s1">'insertId'</span><span class="p">]</span> <span class="o">=</span> <span class="n">row_ids</span><span class="p">[</span><span class="n">index</span><span class="p">]</span>
<span class="n">rows_info</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">info</span><span class="p">)</span>
<span class="k">if</span> <span class="n">skip_invalid_rows</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">data</span><span class="p">[</span><span class="s1">'skipInvalidRows'</span><span class="p">]</span> <span class="o">=</span> <span class="n">skip_invalid_rows</span>
<span class="k">if</span> <span class="n">ignore_unknown_values</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">data</span><span class="p">[</span><span class="s1">'ignoreUnknownValues'</span><span class="p">]</span> <span class="o">=</span> <span class="n">ignore_unknown_values</span>
<span class="k">if</span> <span class="n">template_suffix</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">data</span><span class="p">[</span><span class="s1">'templateSuffix'</span><span class="p">]</span> <span class="o">=</span> <span class="n">template_suffix</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span>
<span class="n">method</span><span class="o">=</span><span class="s1">'POST'</span><span class="p">,</span>
<span class="n">path</span><span class="o">=</span><span class="s1">'</span><span class="si">%s</span><span class="s1">/insertAll'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span>
<span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">error</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'insertErrors'</span><span class="p">,</span> <span class="p">()):</span>
<span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">'index'</span><span class="p">:</span> <span class="nb">int</span><span class="p">(</span><span class="n">error</span><span class="p">[</span><span class="s1">'index'</span><span class="p">]),</span>
<span class="s1">'errors'</span><span class="p">:</span> <span class="n">error</span><span class="p">[</span><span class="s1">'errors'</span><span class="p">]})</span>
<span class="k">return</span> <span class="n">errors</span></div>
<span class="c1"># pylint: disable=too-many-arguments,too-many-locals</span>
<div class="viewcode-block" id="Table.upload_from_file"><a class="viewcode-back" href="../../../bigquery-table.html#gcloud.bigquery.table.Table.upload_from_file">[docs]</a> <span class="k">def</span> <span class="nf">upload_from_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">file_obj</span><span class="p">,</span>
<span class="n">source_format</span><span class="p">,</span>
<span class="n">rewind</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">num_retries</span><span class="o">=</span><span class="mi">6</span><span class="p">,</span>
<span class="n">allow_jagged_rows</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">allow_quoted_newlines</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">create_disposition</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">encoding</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">field_delimiter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">ignore_unknown_values</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">max_bad_records</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">quote_character</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">skip_leading_rows</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">write_disposition</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Upload the contents of this table from a file-like object.</span>
<span class="sd"> The content type of the upload will either be</span>
<span class="sd"> - The value passed in to the function (if any)</span>
<span class="sd"> - ``text/csv``.</span>
<span class="sd"> :type file_obj: file</span>
<span class="sd"> :param file_obj: A file handle opened in binary mode for reading.</span>
<span class="sd"> :type source_format: str</span>
<span class="sd"> :param source_format: one of 'CSV' or 'NEWLINE_DELIMITED_JSON'.</span>
<span class="sd"> job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type rewind: boolean</span>
<span class="sd"> :param rewind: If True, seek to the beginning of the file handle before</span>
<span class="sd"> writing the file to Cloud Storage.</span>
<span class="sd"> :type size: int</span>
<span class="sd"> :param size: The number of bytes to read from the file handle.</span>
<span class="sd"> If not provided, we'll try to guess the size using</span>
<span class="sd"> :func:`os.fstat`. (If the file handle is not from the</span>
<span class="sd"> filesystem this won't be possible.)</span>
<span class="sd"> :type num_retries: integer</span>
<span class="sd"> :param num_retries: Number of upload retries. Defaults to 6.</span>
<span class="sd"> :type allow_jagged_rows: boolean</span>
<span class="sd"> :param allow_jagged_rows: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type allow_quoted_newlines: boolean</span>
<span class="sd"> :param allow_quoted_newlines: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type create_disposition: str</span>
<span class="sd"> :param create_disposition: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type encoding: str</span>
<span class="sd"> :param encoding: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type field_delimiter: str</span>
<span class="sd"> :param field_delimiter: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type ignore_unknown_values: boolean</span>
<span class="sd"> :param ignore_unknown_values: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type max_bad_records: integer</span>
<span class="sd"> :param max_bad_records: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type quote_character: str</span>
<span class="sd"> :param quote_character: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type skip_leading_rows: integer</span>
<span class="sd"> :param skip_leading_rows: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type write_disposition: str</span>
<span class="sd"> :param write_disposition: job configuration option; see</span>
<span class="sd"> :meth:`gcloud.bigquery.job.LoadJob`</span>
<span class="sd"> :type client: :class:`gcloud.storage.client.Client` or ``NoneType``</span>
<span class="sd"> :param client: Optional. The client to use. If not passed, falls back</span>
<span class="sd"> to the ``client`` stored on the current dataset.</span>
<span class="sd"> :rtype: :class:`gcloud.bigquery.jobs.LoadTableFromStorageJob`</span>
<span class="sd"> :returns: the job instance used to load the data (e.g., for</span>
<span class="sd"> querying status)</span>
<span class="sd"> :raises: :class:`ValueError` if ``size`` is not passed in and can not</span>
<span class="sd"> be determined, or if the ``file_obj`` can be detected to be</span>
<span class="sd"> a file opened in text mode.</span>
<span class="sd"> """</span>
<span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_require_client</span><span class="p">(</span><span class="n">client</span><span class="p">)</span>
<span class="n">connection</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">connection</span>
<span class="n">content_type</span> <span class="o">=</span> <span class="s1">'application/octet-stream'</span>
<span class="c1"># Rewind the file if desired.</span>
<span class="k">if</span> <span class="n">rewind</span><span class="p">:</span>
<span class="n">file_obj</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">SEEK_SET</span><span class="p">)</span>
<span class="n">mode</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">file_obj</span><span class="p">,</span> <span class="s1">'mode'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
<span class="k">if</span> <span class="n">mode</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">mode</span> <span class="o">!=</span> <span class="s1">'rb'</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s2">"Cannot upload files opened in text mode: use "</span>
<span class="s2">"open(filename, mode='rb')"</span><span class="p">)</span>
<span class="c1"># Get the basic stats about the file.</span>
<span class="n">total_bytes</span> <span class="o">=</span> <span class="n">size</span>
<span class="k">if</span> <span class="n">total_bytes</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">file_obj</span><span class="p">,</span> <span class="s1">'fileno'</span><span class="p">):</span>
<span class="n">total_bytes</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">fstat</span><span class="p">(</span><span class="n">file_obj</span><span class="o">.</span><span class="n">fileno</span><span class="p">())</span><span class="o">.</span><span class="n">st_size</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'total bytes could not be determined. Please '</span>
<span class="s1">'pass an explicit size.'</span><span class="p">)</span>
<span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'Accept'</span><span class="p">:</span> <span class="s1">'application/json'</span><span class="p">,</span>
<span class="s1">'Accept-Encoding'</span><span class="p">:</span> <span class="s1">'gzip, deflate'</span><span class="p">,</span>
<span class="s1">'User-Agent'</span><span class="p">:</span> <span class="n">connection</span><span class="o">.</span><span class="n">USER_AGENT</span><span class="p">,</span>
<span class="s1">'content-type'</span><span class="p">:</span> <span class="s1">'application/json'</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">metadata</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'configuration'</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">'load'</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">'sourceFormat'</span><span class="p">:</span> <span class="n">source_format</span><span class="p">,</span>
<span class="s1">'schema'</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">'fields'</span><span class="p">:</span> <span class="n">_build_schema_resource</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_schema</span><span class="p">),</span>
<span class="p">},</span>
<span class="s1">'destinationTable'</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">'projectId'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">project</span><span class="p">,</span>
<span class="s1">'datasetId'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
<span class="s1">'tableId'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="n">_configure_job_metadata</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">allow_jagged_rows</span><span class="p">,</span>
<span class="n">allow_quoted_newlines</span><span class="p">,</span> <span class="n">create_disposition</span><span class="p">,</span>
<span class="n">encoding</span><span class="p">,</span> <span class="n">field_delimiter</span><span class="p">,</span>
<span class="n">ignore_unknown_values</span><span class="p">,</span> <span class="n">max_bad_records</span><span class="p">,</span>
<span class="n">quote_character</span><span class="p">,</span> <span class="n">skip_leading_rows</span><span class="p">,</span>
<span class="n">write_disposition</span><span class="p">)</span>
<span class="n">upload</span> <span class="o">=</span> <span class="n">Upload</span><span class="p">(</span><span class="n">file_obj</span><span class="p">,</span> <span class="n">content_type</span><span class="p">,</span> <span class="n">total_bytes</span><span class="p">,</span>
<span class="n">auto_transfer</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">url_builder</span> <span class="o">=</span> <span class="n">_UrlBuilder</span><span class="p">()</span>
<span class="n">upload_config</span> <span class="o">=</span> <span class="n">_UploadConfig</span><span class="p">()</span>
<span class="c1"># Base URL may change once we know simple vs. resumable.</span>
<span class="n">base_url</span> <span class="o">=</span> <span class="n">connection</span><span class="o">.</span><span class="n">API_BASE_URL</span> <span class="o">+</span> <span class="s1">'/upload'</span>
<span class="n">path</span> <span class="o">=</span> <span class="s1">'/projects/</span><span class="si">%s</span><span class="s1">/jobs'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_dataset</span><span class="o">.</span><span class="n">project</span><span class="p">,)</span>
<span class="n">upload_url</span> <span class="o">=</span> <span class="n">connection</span><span class="o">.</span><span class="n">build_api_url</span><span class="p">(</span><span class="n">api_base_url</span><span class="o">=</span><span class="n">base_url</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="n">path</span><span class="p">)</span>
<span class="c1"># Use apitools 'Upload' facility.</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">upload_url</span><span class="p">,</span> <span class="s1">'POST'</span><span class="p">,</span> <span class="n">headers</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">metadata</span><span class="p">))</span>